mirror of
https://dev.iopsys.eu/bbf/bbfdm.git
synced 2025-12-10 07:44:39 +01:00
11931 lines
513 KiB
XML
11931 lines
513 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
||
<!-- DO NOT EDIT; generated by Broadband Forum report.pl#426 (2020-10-21 version) on 2020/11/18 at 09:53:47.
|
||
report.pl -exitcode=fatals -usp -cwmpindex=.. -nofontstyles -nowarnreport -quiet -report=xml -outfile=tr-104-2-0-2-usp-full.xml tr-104-2-0-2-usp.xml -altnotifreqstyle -clampversion=2.12 -ignoreenableparameter -immutablenonfunctionalkeys -markmounttype
|
||
See https://github.com/BroadbandForum/cwmp-xml-tools/tree/master/Report_Tool. -->
|
||
<!--
|
||
TR-069 VoiceService:2.0 Service Object definition [USP]
|
||
|
||
Copyright (c) 2009-2020, 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.
|
||
|
||
Summary:
|
||
TR-104 VoiceService:2.0 Service Object definition.
|
||
|
||
Editors:
|
||
Alexandre Francois, Orange
|
||
Grégory Foucher, Orange
|
||
|
||
Broadband User Services Work Area Directors:
|
||
John Blackford, CommScope
|
||
Jason Walls, QA Cafe
|
||
|
||
Issue History (Filename: Approval Date: Publication Date: Changes):
|
||
* tr-104-1-0-0.xml: September 2009:
|
||
corresponds to TR-104 Issue 1, Section 3 (Data Model Definition) and Section 4 (Profile Definition).
|
||
* tr-104-1-1-0.xml: July 2011:
|
||
corresponds to TR-104 Issue 1, Amendment 1.
|
||
* tr-104-2-0-0.xml: March 2014: April 2014:
|
||
corresponds to TR-104 Issue 2.
|
||
* tr-104-2-0-1-usp.xml: September 2019: September 2019:
|
||
added USP support (split XML into common, CWMP and USP files).
|
||
* tr-104-2-0-2-usp.xml: January 2020: January 2020:
|
||
clarified meaning of SessionID and added new SIPSessionID.
|
||
|
||
-->
|
||
<dm:document xmlns:dm="urn:broadband-forum-org:cwmp:datamodel-1-7"
|
||
xmlns:dmr="urn:broadband-forum-org:cwmp:datamodel-report-0-1"
|
||
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
||
xsi:schemaLocation="urn:broadband-forum-org:cwmp:datamodel-1-7 https://www.broadband-forum.org/cwmp/cwmp-datamodel-1-7.xsd urn:broadband-forum-org:cwmp:datamodel-report-0-1 https://www.broadband-forum.org/cwmp/cwmp-datamodel-report.xsd"
|
||
spec="urn:broadband-forum-org:tr-104-2-0-2-usp" file="tr-104-2-0-2-usp-full.xml">
|
||
<description>
|
||
{{docname|VoiceService:2.0 for USP}}
|
||
{{appdate|January 2020}}
|
||
{{trname|tr-104-2-0-0}}
|
||
March 2014:
|
||
* Original
|
||
September 2019: {{xmlref|tr-104-2-0-1-usp|Corrigendum 1}}
|
||
* Added USP support (split XML into common, CWMP and USP files)
|
||
January 2020: {{xmlref|tr-104-2-0-2-usp|Corrigendum 2}}
|
||
* Clarified meaning of SessionID and added new SIPSessionID
|
||
</description>
|
||
<dataType name="_AliasCommon">
|
||
<description>
|
||
A non-volatile handle used to reference this instance.
|
||
'''This is intended only for use in protocol-independent "common" definitions, and MUST NOT be used in protocol-specific definitions.'''
|
||
</description>
|
||
<string>
|
||
<size maxLength="64"/>
|
||
</string>
|
||
</dataType>
|
||
<dataType name="_AliasCWMP" base="_AliasCommon">
|
||
<description>
|
||
A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.
|
||
If the CPE supports the Alias-based Addressing feature as defined in {{bibref|TR-069|3.6.1}} and described in {{bibref|TR-069|Appendix II}}, the following mandatory constraints MUST be enforced:
|
||
* Its value MUST NOT be empty.
|
||
* Its value MUST start with a letter.
|
||
* If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
|
||
* The CPE MUST NOT change the parameter value.
|
||
</description>
|
||
<size maxLength="64"/>
|
||
</dataType>
|
||
<dataType name="_AliasUSP" base="_AliasCommon">
|
||
<description>
|
||
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.
|
||
The value MUST NOT change once it's been assigned.
|
||
</description>
|
||
<size maxLength="64"/>
|
||
</dataType>
|
||
<dataType name="Dbm1000">
|
||
<description>
|
||
The value is measured in ''dBm/1000'', i.e. the value divided by 1000 is dB relative to 1 mW. For example, -12345 means -12.345 dBm, 0 means 0 dBm (1 mW) and 12345 means 12.345 dBm.
|
||
</description>
|
||
<int>
|
||
</int>
|
||
</dataType>
|
||
<dataType name="DiagnosticsState">
|
||
<description>
|
||
Indicates the availability of diagnostics data. Enumeration of:
|
||
{{enum}}
|
||
If the ACS sets the value of this parameter to {{enum|Requested}}, the CPE MUST initiate the corresponding diagnostic test. When writing, the only allowed values are {{enum|Requested}} and {{enum|Canceled}}. To ensure the use of the proper test parameters (the writable parameters in this object), the test parameters MUST be set, and any errors or inconsistencies in the test parameters MUST be detected, either prior to or at the same time as (in the same SetParameterValues) setting this parameter to {{enum|Requested}}.
|
||
When requested, the CPE SHOULD wait until after completion of the communication session with the ACS before starting the diagnostic test.
|
||
When the test is completed, the value of this parameter MUST be either {{enum|Complete}} (if the test completed successfully), or one of the ''Error'' values listed above.
|
||
If the value of this parameter is anything other than {{enum|Complete}}, the values of the results parameters for this test are indeterminate.
|
||
When the diagnostic initiated by the ACS is completed (successfully or not), but not if it is canceled for any reason, the CPE MUST establish a new connection to the ACS to allow the ACS to view the results, indicating the Event code ''8 DIAGNOSTICS COMPLETE'' in the Inform message.
|
||
After the diagnostic is complete, the value of all result parameters (all read-only parameters in this object) MUST be retained by the CPE until either this diagnostic is run again, or the CPE reboots. After a reboot, if the CPE has not retained the result parameters from the most recent test, it MUST set the value of this parameter to {{enum|None}}.
|
||
Modifying any of the writable parameters in this object except for this one MUST result in the value of this parameter being set to {{enum|None}}.
|
||
While the test is in progress, modifying any of the writable parameters in this object except for this one MUST result in the test being terminated and the value of this parameter being set to {{enum|None}}.
|
||
While the test is in progress, setting this parameter to {{enum|Requested}} (and possibly modifying other writable parameters in this object) MUST result in the test being terminated and then restarted using the current values of the test parameters.
|
||
While the test is in progress, setting this parameter to {{enum|Canceled}} MUST result in the test being canceled and the value of this parameter being set to {{enum|None}}. If the CPE does not support the {{enum|Canceled}} value, it MUST return a SPV error with "Invalid Parameter value" (9007) to the ACS instead.
|
||
</description>
|
||
<string>
|
||
<enumeration value="None" access="readOnly"/>
|
||
<enumeration value="Requested"/>
|
||
<enumeration value="Canceled" optional="true"/>
|
||
<enumeration value="Complete" access="readOnly"/>
|
||
<enumeration value="Error" access="readOnly" optional="true"/>
|
||
</string>
|
||
</dataType>
|
||
<dataType name="IEEE_EUI64">
|
||
<description>
|
||
The IEEE EUI 64-bit identifier as defined in {{bibref|IEEE_EUI64}}. The IEEE defined 64-bit extended unique identifier (EUI-64) is a concatenation of:
|
||
* The 24-bit (OUI-24) or 36-bit (OUI-36) company_id value assigned by the IEEE Registration Authority (IEEE-RA), and
|
||
* The extension identifier (40 bits for OUI-24 or 28 bits for OUI-36) assigned by the organization with that company_id assignment.
|
||
</description>
|
||
<string>
|
||
<size maxLength="23"/>
|
||
<pattern value=""/>
|
||
<pattern value="([0-9A-Fa-f][0-9A-Fa-f]:){7}([0-9A-Fa-f][0-9A-Fa-f])"/>
|
||
</string>
|
||
</dataType>
|
||
<dataType name="IPAddress">
|
||
<description>
|
||
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 {{bibref|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 {{bibref|RFC4007|Section 6}}.
|
||
Unspecified or inapplicable addresses (or IPv4 subnet masks) MUST be represented as empty strings unless otherwise specified by the parameter definition.
|
||
</description>
|
||
<string>
|
||
<size maxLength="45"/>
|
||
</string>
|
||
</dataType>
|
||
<dataType name="IPv4Address" base="IPAddress">
|
||
<description>
|
||
IPv4 address (or subnet mask).
|
||
Can be any IPv4 address that is permitted by the ''IPAddress'' data type.
|
||
</description>
|
||
<size maxLength="15"/>
|
||
<pattern value=""/>
|
||
<pattern value="((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])"/>
|
||
</dataType>
|
||
<dataType name="IPv6Address" base="IPAddress">
|
||
<description>
|
||
IPv6 address.
|
||
Can be any IPv6 address that is permitted by the ''IPAddress'' data type.
|
||
</description>
|
||
<size maxLength="45"/>
|
||
</dataType>
|
||
<dataType name="IPPrefix">
|
||
<description>
|
||
IPv4 or IPv6 routing prefix in Classless Inter-Domain Routing (CIDR) notation {{bibref|RFC4632}}. This is specified as an IP address followed by an appended "/n" suffix, where ''n'' (the prefix size) is an integer in the range 0-32 (for IPv4) or 0-128 (for IPv6) that indicates the number of (leftmost) '1' bits of the routing prefix.
|
||
* IPv4 example: 192.168.1.0/24
|
||
* IPv6 example: 2001:edff:fe6a:f76::/64
|
||
If the IP address part is unspecified or inapplicable, it MUST be {{empty}} unless otherwise specified by the parameter definition. In this case the IP prefix will be of the form "/n".
|
||
If the entire IP prefix is unspecified or inapplicable, it MUST be {{empty}} unless otherwise specified by the parameter definition.
|
||
</description>
|
||
<string>
|
||
<size maxLength="49"/>
|
||
</string>
|
||
</dataType>
|
||
<dataType name="IPv4Prefix" base="IPPrefix">
|
||
<description>
|
||
IPv4 address prefix.
|
||
Can be any IPv4 prefix that is permitted by the ''IPPrefix'' data type.
|
||
</description>
|
||
<size maxLength="18"/>
|
||
<pattern value=""/>
|
||
<pattern value="/(3[0-2]|[012]?[0-9])"/>
|
||
<pattern value="((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])/(3[0-2]|[012]?[0-9])"/>
|
||
</dataType>
|
||
<dataType name="IPv6Prefix" base="IPPrefix">
|
||
<description>
|
||
IPv6 address prefix.
|
||
Can be any IPv6 prefix that is permitted by the ''IPPrefix'' data type.
|
||
</description>
|
||
<size maxLength="49"/>
|
||
</dataType>
|
||
<dataType name="JSONObject">
|
||
<description>
|
||
A JSON Object as defined in {{bibref|RFC7159|Section 4}}.
|
||
</description>
|
||
<string>
|
||
</string>
|
||
</dataType>
|
||
<dataType name="MACAddress">
|
||
<description>
|
||
All MAC addresses are represented as strings of 12 hexadecimal digits (digits 0-9, letters A-F or a-f) displayed as six pairs of digits separated by colons. Unspecified or inapplicable MAC addresses MUST be represented as empty strings unless otherwise specified by the parameter definition.
|
||
</description>
|
||
<string>
|
||
<size maxLength="17"/>
|
||
<pattern value=""/>
|
||
<pattern value="([0-9A-Fa-f][0-9A-Fa-f]:){5}([0-9A-Fa-f][0-9A-Fa-f])"/>
|
||
</string>
|
||
</dataType>
|
||
<dataType name="StatsCounter32">
|
||
<description>
|
||
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.
|
||
</description>
|
||
<unsignedInt>
|
||
</unsignedInt>
|
||
</dataType>
|
||
<dataType name="StatsCounter64">
|
||
<description>
|
||
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.
|
||
</description>
|
||
<unsignedLong>
|
||
</unsignedLong>
|
||
</dataType>
|
||
<dataType name="UUID">
|
||
<description>
|
||
Universally Unique Identifier. See {{bibref|RFC4122}}.
|
||
</description>
|
||
<string>
|
||
<size minLength="36" maxLength="36"/>
|
||
<pattern value="[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}"/>
|
||
</string>
|
||
</dataType>
|
||
<dataType name="URI">
|
||
<description>
|
||
Uniform Resource Identifier. See {{bibref|RFC3986}}.
|
||
</description>
|
||
<string>
|
||
<size maxLength="2048"/>
|
||
</string>
|
||
</dataType>
|
||
<dataType name="URN" base="URI">
|
||
<description>
|
||
Uniform Resource Name. See {{bibref|RFC3986}} (URI) and {{bibref|RFC8141}} (''urn'' URI scheme).
|
||
</description>
|
||
<size maxLength="2048"/>
|
||
<pattern value="urn:[A-Za-z0-9][A-Za-z0-9-]{0,30}[A-Za-z0-9]:.+"/>
|
||
</dataType>
|
||
<dataType name="URL" base="URI">
|
||
<description>
|
||
Uniform Resource Locator. See {{bibref|RFC3986}} (URI), {{bibref|IANA-uri-schemes}}, and individual URI scheme RFCs such as {{bibref|RFC7252}} (''coap'', ''coaps'') and {{bibref|RFC7230}} (''http'', ''https'').
|
||
</description>
|
||
<size maxLength="2048"/>
|
||
</dataType>
|
||
<dataType name="ZigBeeNetworkAddress">
|
||
<description>
|
||
The ZigBee 16-bit network address (NWK) as defined in {{bibref|ZigBee2007}}. The address is assigned to a device by the network layer and used by the network layer for routing messages between devices.
|
||
</description>
|
||
<string>
|
||
<size maxLength="4"/>
|
||
<pattern value=""/>
|
||
<pattern value="([0-9A-Fa-f]){4}"/>
|
||
</string>
|
||
</dataType>
|
||
<dataType name="Alias" base="_AliasCommon">
|
||
<description>
|
||
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.
|
||
The value MUST NOT change once it's been assigned.
|
||
</description>
|
||
<size maxLength="64"/>
|
||
</dataType>
|
||
<bibliography>
|
||
<reference id="3GPP_TS_24.229">
|
||
<name>3GPP TS 24.229</name>
|
||
<title>IP Multimedia Call Control Protocol based on Session Initiation Protocol (SIP) and Session Description Protocol (SDP); Stage 3</title>
|
||
<organization>3GPP CT WG1</organization>
|
||
<category>Technical specification</category>
|
||
<hyperlink>https://www.3gpp.org/ftp/Specs/html-info/24229.htm</hyperlink>
|
||
</reference>
|
||
<reference id="802.1D-2004">
|
||
<name>IEEE Std 802.1D-2004</name>
|
||
<title>Media Access Control (MAC) Bridges</title>
|
||
<organization>IEEE</organization>
|
||
<date>2004</date>
|
||
<hyperlink>https://standards.ieee.org/getieee802/download/802.1D-2004.pdf</hyperlink>
|
||
</reference>
|
||
<reference id="802.1Q-2005">
|
||
<name>IEEE Std 802.1Q-2005</name>
|
||
<title>Virtual Bridged Local Area Networks</title>
|
||
<organization>IEEE</organization>
|
||
<date>2006</date>
|
||
<hyperlink>https://standards.ieee.org/getieee802/download/802.1Q-2005.pdf</hyperlink>
|
||
</reference>
|
||
<reference id="ETSI_EN_300_444">
|
||
<name>ETSI EN 300 444</name>
|
||
<title>Digital Enhanced Cordless Telecommunications (DECT); Generic Access Profile (GAP)</title>
|
||
<organization>ETSI</organization>
|
||
<category>Standard</category>
|
||
<hyperlink>https://www.etsi.org/deliver/etsi_en/300400_300499/300444/02.04.01_60/en_300444v020401p.pdf</hyperlink>
|
||
</reference>
|
||
<reference id="ETSI_EN_300_175-5">
|
||
<name>ETSI EN 300 175-05</name>
|
||
<title>Digital Enhanced Cordless Telecommunications (DECT); Common Interface (CI); Part 5: Network (NWK) layer</title>
|
||
<organization>ETSI</organization>
|
||
<category>Standard</category>
|
||
<hyperlink>https://www.etsi.org/deliver/etsi_en/300100_300199/30017505/02.05.01_60/en_30017505v020501p.pdf</hyperlink>
|
||
</reference>
|
||
<reference id="ETSI_EN_300_175-6">
|
||
<name>ETSI EN 300 175-6</name>
|
||
<title>Digital Enhanced Cordless Telecommunications (DECT); Common Interface (CI); Part 6: Identities and addressing</title>
|
||
<organization>ETSI</organization>
|
||
<category>Standard</category>
|
||
<hyperlink>https://www.etsi.org/deliver/etsi_en/300100_300199/30017506/02.05.01_60/en_30017506v020501p.pdf</hyperlink>
|
||
</reference>
|
||
<reference id="ETSI_EN_300_175-7">
|
||
<name>ETSI 300 175-7</name>
|
||
<title>Digital Enhanced Cordless Telecommunications (DECT); Common Interface (CI); Part 7: Security features</title>
|
||
<organization>ETSI</organization>
|
||
<category>Standard</category>
|
||
<hyperlink>https://www.etsi.org/deliver/etsi_en/300100_300199/30017507/02.05.01_60/en_30017507v020501p.pdf</hyperlink>
|
||
</reference>
|
||
<reference id="ETSI_EN_300_175-8">
|
||
<name>ETSI 300 175-8</name>
|
||
<title>Digital Enhanced Cordless Telecommunications (DECT); Common Interface (CI); Part 8: Speech and audio coding and transmission</title>
|
||
<organization>ETSI</organization>
|
||
<category>Standard</category>
|
||
<hyperlink>https://www.etsi.org/deliver/etsi_en/300100_300199/30017508/02.05.01_60/en_30017508v020501p.pdf</hyperlink>
|
||
</reference>
|
||
<reference id="ETSI_ES_201_970">
|
||
<name>ETSI ES 201 970</name>
|
||
<title>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)</title>
|
||
<organization>ETSI</organization>
|
||
<category>Standard</category>
|
||
<hyperlink>https://www.etsi.org/deliver/etsi_es/201900_201999/201970/01.01.01_60/es_201970v010101p.pdf</hyperlink>
|
||
</reference>
|
||
<reference id="ETSI_ES_203_021">
|
||
<name>ETSI ES 203 021</name>
|
||
<title>Access and Terminals (AT); Harmonized basic attachment requirements for Terminals for connection to analogue interfaces of the Telephone Networks</title>
|
||
<organization>ETSI</organization>
|
||
<category>Standard</category>
|
||
<hyperlink>https://www.etsi.org/WebSite/Technologies/analogueline.aspx</hyperlink>
|
||
</reference>
|
||
<reference id="ETSI_TR_101_183">
|
||
<name>ETSI TR 101 183</name>
|
||
<title>Public Switched Telephone Network (PSTN); Analogue ringing signals</title>
|
||
<organization>ETSI</organization>
|
||
<category>Technical Report</category>
|
||
<hyperlink>https://www.etsi.org/deliver/etsi_tr/101100_101199/101183/01.01.01_60/tr_101183v010101p.pdf</hyperlink>
|
||
</reference>
|
||
<reference id="ETSI_TS_102_527-1">
|
||
<name>ETSI TS 102 527-1</name>
|
||
<title>Digital Enhanced Cordless Telecommunications (DECT); New Generation DECT; Part 1: Wideband speech</title>
|
||
<organization>ETSI</organization>
|
||
<category>Technical Specification</category>
|
||
<hyperlink>https://www.etsi.org/deliver/etsi_ts/102500_102599/10252701/01.03.01_60/ts_10252701v010301p.pdf</hyperlink>
|
||
</reference>
|
||
<reference id="ETSI_TS_102_527-3">
|
||
<name>ETSI TS 102 527-3</name>
|
||
<title>Digital Enhanced Cordless Telecommunications (DECT); New Generation DECT; Part 3: Extended wideband speech services</title>
|
||
<organization>ETSI</organization>
|
||
<category>Technical Specification</category>
|
||
<hyperlink>https://www.etsi.org/deliver/etsi_ts/102500_102599/10252703/01.05.01_60/ts_10252703v010501p.pdf</hyperlink>
|
||
</reference>
|
||
<reference id="ETSI_TS_102_527-4">
|
||
<name>ETSI TS 102 527-4</name>
|
||
<title>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</title>
|
||
<organization>ETSI</organization>
|
||
<category>Technical Specification</category>
|
||
<hyperlink>https://www.etsi.org/deliver/etsi_ts/102500_102599/10252704/01.01.01_60/ts_10252704v010101p.pdf</hyperlink>
|
||
</reference>
|
||
<reference id="ETSI_TS_102_527-5">
|
||
<name>ETSI TS 102 527-5</name>
|
||
<title>Digital Enhanced Cordless Telecommunications (DECT); New Generation DECT; Part 5: Additional feature set nr. 1 for extended wideband speech services</title>
|
||
<organization>ETSI</organization>
|
||
<category>Technical Specification</category>
|
||
<hyperlink>https://www.etsi.org/deliver/etsi_ts/102500_102599/10252705/01.01.01_60/ts_10252705v010101p.pdf</hyperlink>
|
||
</reference>
|
||
<reference id="ETSI_TS_181_019">
|
||
<name>ETSI TS 181 019</name>
|
||
<title>Telecommunications and Internet converged Services and Protocols for Advanced Networking (TISPAN)</title>
|
||
<organization>ETSI</organization>
|
||
<category>Standard</category>
|
||
<hyperlink>https://www.etsi.org/deliver/etsi_ts/181000_181099/181019/02.00.00_60/ts_181019v020000p.pdf</hyperlink>
|
||
</reference>
|
||
<reference id="H.323">
|
||
<name>H.323</name>
|
||
<title>Packet-based multimedia communications systems</title>
|
||
<organization>ITU-T</organization>
|
||
<category>H series</category>
|
||
<hyperlink>https://www.itu.int/rec/T-REC-H.323-200912-I</hyperlink>
|
||
</reference>
|
||
<reference id="H.235.1">
|
||
<name>H.235.1</name>
|
||
<title>H.323 security framework: Baseline security profile</title>
|
||
<organization>ITU-T</organization>
|
||
<category>H series</category>
|
||
<hyperlink>https://www.itu.int/rec/T-REC-H.235.1</hyperlink>
|
||
</reference>
|
||
<reference id="I.251.1">
|
||
<name>I.251.1</name>
|
||
<title>Number identification supplementary services : Direct-dialling-In</title>
|
||
<organization>ITU-T</organization>
|
||
<category>I series</category>
|
||
<hyperlink>https://www.itu.int/rec/T-REC-I.251.1</hyperlink>
|
||
</reference>
|
||
<reference id="I.251.2">
|
||
<name>I.251.2</name>
|
||
<title>Number identification supplementary services : Multiple Subscriber Number</title>
|
||
<organization>ITU-T</organization>
|
||
<category>I series</category>
|
||
<hyperlink>https://www.itu.int/rec/T-REC-I.251.2</hyperlink>
|
||
</reference>
|
||
<reference id="I.251.7">
|
||
<name>I.251.7</name>
|
||
<title>Number identification supplementary services : Malicious call Identification</title>
|
||
<organization>ITU-T</organization>
|
||
<category>I series</category>
|
||
<hyperlink>https://www.itu.int/rec/T-REC-I.251.7</hyperlink>
|
||
</reference>
|
||
<reference id="I.252.7">
|
||
<name>I.252.7</name>
|
||
<title>Call offering supplementary services : Explicit call transfer</title>
|
||
<organization>ITU-T</organization>
|
||
<category>I series</category>
|
||
<hyperlink>https://www.itu.int/rec/T-REC-I.252.7</hyperlink>
|
||
</reference>
|
||
<reference id="I.256.2a">
|
||
<name>I.256.2a</name>
|
||
<title>Charging supplementary services : Advice of charge: charging information at call set-up time (AOC-S)</title>
|
||
<organization>ITU-T</organization>
|
||
<category>I series</category>
|
||
<hyperlink>https://www.itu.int/rec/T-REC-I.256.2a</hyperlink>
|
||
</reference>
|
||
<reference id="I.256.2c">
|
||
<name>I.256.2c</name>
|
||
<title>Charging supplementary services : Advice of charge: charging information at the end of the call (AOC-E)</title>
|
||
<organization>ITU-T</organization>
|
||
<category>I series</category>
|
||
<hyperlink>https://www.itu.int/rec/T-REC-I.256.2c</hyperlink>
|
||
</reference>
|
||
<reference id="I.256.2b">
|
||
<name>I.256.2b</name>
|
||
<title>Charging supplementary services : Advice of charge: charging information during the call (AOC-D)</title>
|
||
<organization>ITU-T</organization>
|
||
<category>I series</category>
|
||
<hyperlink>https://www.itu.int/rec/T-REC-I.256.2b</hyperlink>
|
||
</reference>
|
||
<reference id="IANA_Event_Packages">
|
||
<name>IANA SIP Event packages and Event-template packages Registry</name>
|
||
<title>Session Initiation Protocol (SIP) Event Types Namespace</title>
|
||
<organization>IANA</organization>
|
||
<hyperlink>https://www.iana.org/assignments/sip-events/sip-events.xhtml#sip-events-2</hyperlink>
|
||
</reference>
|
||
<reference id="IANA_SIP_Methods">
|
||
<name>IANA SIP Methods Registry</name>
|
||
<title>Session Initiation Protocol (SIP) Parameters : Methods and Response Codes</title>
|
||
<organization>IANA</organization>
|
||
<hyperlink>https://www.iana.org/assignments/sip-parameters/sip-parameters.xhtml#sip-parameters-6</hyperlink>
|
||
</reference>
|
||
<reference id="ISO3166-1">
|
||
<name>ISO 3166-1</name>
|
||
<title>Codes for the representation of names of countries and their subdivisions - Part 1: Country codes</title>
|
||
<organization>ISO</organization>
|
||
<date>2006</date>
|
||
<hyperlink>https://www.iso.org/iso/country_codes.htm</hyperlink>
|
||
</reference>
|
||
<reference id="Q.931">
|
||
<name>Q.931</name>
|
||
<title>ISDN user-network interface layer 3 specification for basic call control.</title>
|
||
<organization>ITU-T</organization>
|
||
<category>Q series</category>
|
||
<hyperlink>https://www.itu.int/rec/T-REC-Q.931</hyperlink>
|
||
</reference>
|
||
<reference id="RFC2198">
|
||
<name>RFC 2198</name>
|
||
<title>RTP Payload for Redundant Audio Data</title>
|
||
<organization>IETF</organization>
|
||
<category>RFC</category>
|
||
<hyperlink>https://tools.ietf.org/html/rfc2198</hyperlink>
|
||
</reference>
|
||
<reference id="RFC2782">
|
||
<name>RFC 2782</name>
|
||
<title>A DNS RR for specifying the location of services (DNS SRV)</title>
|
||
<organization>IETF</organization>
|
||
<category>RFC</category>
|
||
<date>2000</date>
|
||
<hyperlink>https://tools.ietf.org/html/rfc2782</hyperlink>
|
||
</reference>
|
||
<reference id="RFC3261">
|
||
<name>RFC 3261</name>
|
||
<title>SIP: Session Initiation Protocol</title>
|
||
<organization>IETF</organization>
|
||
<category>RFC</category>
|
||
<date>June 2002</date>
|
||
<hyperlink>https://tools.ietf.org/html/rfc3261</hyperlink>
|
||
</reference>
|
||
<reference id="RFC3435">
|
||
<name>RFC 3435</name>
|
||
<title>Media Gateway Control Protocol (MGCP) Version 1.0</title>
|
||
<organization>IETF</organization>
|
||
<category>RFC</category>
|
||
<hyperlink>https://tools.ietf.org/html/rfc3435</hyperlink>
|
||
</reference>
|
||
<reference id="RFC3550">
|
||
<name>RFC 3550</name>
|
||
<title>RTP: A Transport Protocol for Real-Time Applications</title>
|
||
<organization>IETF</organization>
|
||
<category>RFC</category>
|
||
<date>July 2003</date>
|
||
<hyperlink>https://tools.ietf.org/html/rfc3550</hyperlink>
|
||
</reference>
|
||
<reference id="RFC3611">
|
||
<name>RFC 3611</name>
|
||
<title>RTP Control Protocol Extended Reports (RTCP XR)</title>
|
||
<organization>IETF</organization>
|
||
<category>RFC</category>
|
||
<hyperlink>https://tools.ietf.org/html/rfc3611</hyperlink>
|
||
</reference>
|
||
<reference id="RFC4733">
|
||
<name>RFC 4733</name>
|
||
<title>RTP Payload for DTMF Digits, Telephony Tones and Telephony Signals</title>
|
||
<organization>IETF</organization>
|
||
<category>RFC</category>
|
||
<hyperlink>https://tools.ietf.org/html/rfc4733</hyperlink>
|
||
</reference>
|
||
<reference id="RFC6140">
|
||
<name>RFC 6140</name>
|
||
<title>Registration for Multiple Phone Numbers in the Session Initiation Protocol (SIP)</title>
|
||
<organization>IETF</organization>
|
||
<category>RFC</category>
|
||
<hyperlink>https://tools.ietf.org/html/rfc6140</hyperlink>
|
||
</reference>
|
||
<reference id="SOAP1.1">
|
||
<name>Simple Object Access Protocol (SOAP) 1.1</name>
|
||
<organization>W3C</organization>
|
||
<hyperlink>https://www.w3.org/TR/2000/NOTE-SOAP-20000508</hyperlink>
|
||
</reference>
|
||
<reference id="T.38">
|
||
<name>T.38</name>
|
||
<title>Procedures for real-time Group 3 facsimile communication over IP networks.</title>
|
||
<organization>ITU-T</organization>
|
||
<category>T series</category>
|
||
<hyperlink>https://www.itu.int/rec/T-REC-T.38-201009-I</hyperlink>
|
||
</reference>
|
||
<reference id="TR-069a4">
|
||
<name>TR-069 Amendment 4</name>
|
||
<title>CPE WAN Management Protocol</title>
|
||
<organization>Broadband Forum</organization>
|
||
<category>Technical Report</category>
|
||
<date>July 2011</date>
|
||
<hyperlink>https://www.broadband-forum.org/technical/download/TR-069_Amendment-4.pdf</hyperlink>
|
||
</reference>
|
||
<reference id="TR-104i2">
|
||
<name>TR-104 Issue 2</name>
|
||
<title>Provisioning Parameters for VoIP CPE</title>
|
||
<organization>Broadband Forum</organization>
|
||
<category>Technical Report</category>
|
||
<date>March 2014</date>
|
||
<hyperlink>https://www.broadband-forum.org/technical/download/TR-104_Issue-2.pdf</hyperlink>
|
||
</reference>
|
||
<reference id="TR-106">
|
||
<name>TR-106 Amendment 8</name>
|
||
<title>Data Model Template for CWMP Endpoints and USP Agents</title>
|
||
<organization>Broadband Forum</organization>
|
||
<category>Technical Report</category>
|
||
<date>May 2018</date>
|
||
<hyperlink>https://www.broadband-forum.org/technical/download/TR-106.pdf</hyperlink>
|
||
</reference>
|
||
<reference id="TR-106a2">
|
||
<name>TR-106 Amendment 2</name>
|
||
<title>Data Model Template for TR-069-Enabled Devices</title>
|
||
<organization>Broadband Forum</organization>
|
||
<category>Technical Report</category>
|
||
<date>November 2008</date>
|
||
<hyperlink>https://www.broadband-forum.org/technical/download/TR-106_Amendment-2.pdf</hyperlink>
|
||
</reference>
|
||
<reference id="TR-106a7">
|
||
<name>TR-106 Amendment 7</name>
|
||
<title>Data Model Template for TR-069-Enabled Devices</title>
|
||
<organization>Broadband Forum</organization>
|
||
<category>Technical Report</category>
|
||
<date>September 2013</date>
|
||
<hyperlink>https://www.broadband-forum.org/technical/download/TR-106_Amendment-7.pdf</hyperlink>
|
||
</reference>
|
||
<reference id="TR-106a8">
|
||
<name>TR-106 Amendment 8</name>
|
||
<title>Data Model Template for CWMP Endpoints and USP Agents</title>
|
||
<organization>Broadband Forum</organization>
|
||
<category>Technical Report</category>
|
||
<date>May 2018</date>
|
||
<hyperlink>https://www.broadband-forum.org/technical/download/TR-106_Amendment-8.pdf</hyperlink>
|
||
</reference>
|
||
<reference id="Y.1540">
|
||
<name>Y.1540</name>
|
||
<title>IP packet transfer and availability performance parameters</title>
|
||
<organization>ITU-T</organization>
|
||
<category>Y series</category>
|
||
<hyperlink>https://www.itu.int/rec/T-REC-Y.1540</hyperlink>
|
||
</reference>
|
||
</bibliography>
|
||
<model name="VoiceService:2.0" isService="true">
|
||
<parameter name="VoiceServiceNumberOfEntries" access="readOnly" version="2.0">
|
||
<description>
|
||
{{numentries}}
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
<object name="VoiceService.{i}." access="readOnly" numEntriesParameter="VoiceServiceNumberOfEntries" minEntries="0" maxEntries="unbounded" version="2.0">
|
||
<description>
|
||
The top-level object for CPE with voice capabilities.
|
||
</description>
|
||
<uniqueKey functional="false">
|
||
<parameter ref="Alias"/>
|
||
</uniqueKey>
|
||
<parameter name="Alias" access="readWrite" activeNotify="canDeny" version="2.0">
|
||
<description>
|
||
{{datatype|expand}}
|
||
</description>
|
||
<syntax>
|
||
<dataType ref="Alias"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="VoIPProfileNumberOfEntries" access="readOnly" version="2.0">
|
||
<description>
|
||
{{numentries}}
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="CodecProfileNumberOfEntries" access="readOnly" version="2.0">
|
||
<description>
|
||
{{numentries}}
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="InterworkNumberOfEntries" access="readOnly" version="2.0">
|
||
<description>
|
||
{{numentries}}
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="TrunkNumberOfEntries" access="readOnly" version="2.0">
|
||
<description>
|
||
{{numentries}}
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="CallLogNumberOfEntries" access="readOnly" activeNotify="canDeny" version="2.0">
|
||
<description>
|
||
{{numentries}}
|
||
The value MUST be less than or equal to {{param|.Capabilities.MaxCallLogCount}}.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="TerminalNumberOfEntries" access="readOnly" version="2.0">
|
||
<description>
|
||
{{numentries}}
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.Capabilities." access="readOnly" minEntries="1" maxEntries="1" version="2.0">
|
||
<description>
|
||
The overall capabilities of the VoIP CPE.
|
||
</description>
|
||
<parameter name="MaxLineCount" access="readOnly" version="2.0">
|
||
<description>
|
||
Maximum total number of {{object|.CallControl.Line}} objects supported.
|
||
A value of -1 indicates no specific limit on the number of lines.
|
||
</description>
|
||
<syntax>
|
||
<int>
|
||
<range minInclusive="-1"/>
|
||
</int>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="MaxExtensionCount" access="readOnly" version="2.0">
|
||
<description>
|
||
Maximum total number of {{object|.CallControl.Extension}} objects supported.
|
||
A value of -1 indicates no specific limit on the number of extensions.
|
||
</description>
|
||
<syntax>
|
||
<int>
|
||
<range minInclusive="-1"/>
|
||
</int>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="MaxCallLogCount" access="readOnly" version="2.0">
|
||
<description>
|
||
Maximum total number of {{object|.CallLog}} objects supported.
|
||
A value of -1 indicates no specific limit on the number of call logs.
|
||
</description>
|
||
<syntax>
|
||
<int>
|
||
<range minInclusive="-1"/>
|
||
</int>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="MaxSessionsPerLine" access="readOnly" version="2.0">
|
||
<description>
|
||
Maximum number of voice sessions supported for any given {{object|.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.
|
||
</description>
|
||
<syntax>
|
||
<int>
|
||
<range minInclusive="-1"/>
|
||
</int>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="MaxSessionsPerExtension" access="readOnly" version="2.0">
|
||
<description>
|
||
Maximum number of voice sessions supported for any given {{object|.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.
|
||
</description>
|
||
<syntax>
|
||
<int>
|
||
<range minInclusive="-1"/>
|
||
</int>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="MaxSessionCount" access="readOnly" version="2.0">
|
||
<description>
|
||
Maximum total number of voice sessions supported across all {{object|.CallControl.Line}} objects. (This might differ from {{param|MaxLineCount}} if each line can support more than one session for CPE-provided conference calling. This value MAY be less than the product of {{param|MaxLineCount}} and {{param|MaxSessionsPerLine}}.)
|
||
A value of -1 indicates no specific limit on the number of voice sessions.
|
||
</description>
|
||
<syntax>
|
||
<int>
|
||
<range minInclusive="-1"/>
|
||
</int>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="NetworkConnectionModes" access="readOnly" version="2.0">
|
||
<description>
|
||
{{list}} Each item is a supported network connection mode. {{pattern}}
|
||
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 {{bibref|TR-106}}. For example:
|
||
"X_EXAMPLE-COM_MyMode"
|
||
</description>
|
||
<syntax>
|
||
<list/>
|
||
<string>
|
||
<pattern value="SIP(/\d+\.\d+)?" version="2.0"/>
|
||
<pattern value="MGCP(/\d+\.\d+)?" version="2.0"/>
|
||
<pattern value="MGCP-NCS(/\d+\.\d+)?" version="2.0"/>
|
||
<pattern value="H\.248(/\d+\.\d+)?" version="2.0"/>
|
||
<pattern value="H\.323(/\d+\.\d+)?" version="2.0"/>
|
||
<pattern value="DSS1" version="2.0"/>
|
||
<pattern value="FXO" version="2.0"/>
|
||
<pattern value="X_.+" version="2.0"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="UserConnectionModes" access="readOnly" version="2.0">
|
||
<description>
|
||
{{list}} Each item is a supported user connection mode. {{pattern}}
|
||
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 {{bibref|TR-106}}. For example:
|
||
"X_EXAMPLE-COM_MyMode"
|
||
</description>
|
||
<syntax>
|
||
<list/>
|
||
<string>
|
||
<pattern value="SIP(/\d+\.\d+)?" version="2.0"/>
|
||
<pattern value="DSS1" version="2.0"/>
|
||
<pattern value="FXS" version="2.0"/>
|
||
<pattern value="DECT(/\d+\.\d+)?" version="2.0"/>
|
||
<pattern value="Button" version="2.0"/>
|
||
<pattern value="Virtual" version="2.0"/>
|
||
<pattern value="X_.+" version="2.0"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="ToneFileFormats" access="readOnly" version="2.0">
|
||
<description>
|
||
{{list}} Each item is a supported tone file format. The specified file formats are raw codec data files, using one of the codecs listed below. {{enum}}
|
||
The list MAY include vendor-specific -specific extensions, which MUST use the format defined in {{bibref|TR-106}}.
|
||
Example:
|
||
"G.711MuLaw, MP3, X_EXAMPLE-COM_MyFileFormat"
|
||
If the CPE does not support tone files, this parameter MUST be {{empty}}.
|
||
</description>
|
||
<syntax>
|
||
<list/>
|
||
<string>
|
||
<enumeration value="G.711MuLaw" version="2.0"/>
|
||
<enumeration value="G.711ALaw" version="2.0"/>
|
||
<enumeration value="G.729" version="2.0"/>
|
||
<enumeration value="MP3" version="2.0"/>
|
||
<enumeration value="WAV" version="2.0"/>
|
||
<enumeration value="AMR" version="2.0"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="RingFileFormats" access="readOnly" version="2.0">
|
||
<description>
|
||
{{list}} Each item is a supported ring file format. {{enum}}
|
||
The list MAY include vendor-specific-specific extensions, which MUST use the format defined in {{bibref|TR-106}}.
|
||
Example:
|
||
"MIDI, AMR, X_EXAMPLE-COM_MyFileFormat"
|
||
If the CPE does not support ring files, this parameter MUST be {{empty}}.
|
||
</description>
|
||
<syntax>
|
||
<list/>
|
||
<string>
|
||
<enumeration value="MIDI" version="2.0"/>
|
||
<enumeration value="SMAF" version="2.0">
|
||
<description>
|
||
MMF
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="RTTTL" version="2.0">
|
||
<description>
|
||
RTTTL or RTX
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="MP3" version="2.0"/>
|
||
<enumeration value="WAV" version="2.0"/>
|
||
<enumeration value="AMR" version="2.0"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="FacilityActions" access="readOnly" version="2.0">
|
||
<description>
|
||
The facility actions supported by this VoiceService. {{enum}}
|
||
The list MAY include vendor-specific Facility Actions, which MUST use the format defined in {{bibref|TR-106}}.
|
||
Facility Actions are referenced in the VoiceService data model in the objects {{object|.CallControl.NumberingPlan.{i}.PrefixInfo.{i}.}} and {{object|.Terminal.{i}.ButtonMap.Button.{i}.}}.
|
||
</description>
|
||
<syntax>
|
||
<list/>
|
||
<string>
|
||
<enumeration value="AA_REGISTER" version="2.0">
|
||
<description>
|
||
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.
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="AA_ERASE" version="2.0">
|
||
<description>
|
||
Remove an "Abbreviated Address".
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="AA_INTERROGATE" version="2.0">
|
||
<description>
|
||
Interrogate the status of an "Abbreviated Address".
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="CA_ACTIVATE" version="2.0">
|
||
<description>
|
||
Make this call an anonymous call.
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="CCBS_ACTIVATE" version="2.0">
|
||
<description>
|
||
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.
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="CCBS_DEACTIVATE" version="2.0">
|
||
<description>
|
||
Deactivation of Call Completion to Busy Subscriber.
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="CCBS_INTERROGATE" version="2.0">
|
||
<description>
|
||
Interrogation of the Call Completion to Busy Subscriber status and destination.
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="CCNR_ACTIVATE" version="2.0">
|
||
<description>
|
||
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.
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="CCNR_DEACTIVATE" version="2.0">
|
||
<description>
|
||
Deactivation of Call Completion on No Reply.
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="CCNR_INTERROGATE" version="2.0">
|
||
<description>
|
||
Interrogation of the Call Completion on No Reply status and destination.
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="CFB_REGISTER" version="2.0">
|
||
<description>
|
||
Register the destination for Call Forwarding on Busy.
|
||
Set the parameter {{param|.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".
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="CFB_ACTIVATE" version="2.0">
|
||
<description>
|
||
Activate Call Forwarding on Busy to the registered destination.
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="CFB_DEACTIVATE" version="2.0">
|
||
<description>
|
||
Deactivate Call Forwarding on Busy to the registered destination.
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="CFB_ERASE" version="2.0">
|
||
<description>
|
||
Erase the registered Call Forwarding on Busy Destination.
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="CFB_INTERROGATE" version="2.0">
|
||
<description>
|
||
Interrogate the registered Call Forwarding on Busy Destination.
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="CFNR_REGISTER" version="2.0">
|
||
<description>
|
||
Register the destination for Call Forwarding on No Reply.
|
||
Set the parameter {{param|.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.
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="CFNR_ACTIVATE" version="2.0">
|
||
<description>
|
||
Activate Call Forwarding on No Reply to the registered destination.
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="CFNR_DEACTIVATE" version="2.0">
|
||
<description>
|
||
Deactivate Call Forwarding on No Reply to the registered destination.
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="CFNR_ERASE" version="2.0">
|
||
<description>
|
||
Erase the registered Call Forwarding on No Reply Destination.
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="CFNR_INTERROGATE" version="2.0">
|
||
<description>
|
||
Interrogate the registered Call Forwarding on No Reply Destination.
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="CFNR_TIMER" version="2.0">
|
||
<description>
|
||
Set the parameter {{param|.CallControl.CallingFeatures.Set.{i}.CallForwardOnNoAnswerRingTimeout}} of this extension.
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="CFT_ACTIVATE" version="2.0">
|
||
<description>
|
||
Activate Call Forwarding Timed. This facility permits the user to forward calls to particular destinations depending on the time of day : cf. table {{object|.CallControl.CallingFeatures.Set.{i}.CFT.{i}.}}
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="CFT_DEACTIVATE" version="2.0">
|
||
<description>
|
||
Deactivate Call Forwarding Timed.
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="CFT_INTERROGATE" version="2.0">
|
||
<description>
|
||
Interrogate the status of Call Forwarding Timed.
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="CFU_REGISTER" version="2.0">
|
||
<description>
|
||
Register the destination for Call Forwarding Unconditional.
|
||
Set the parameter {{param|.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".
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="CFU_ACTIVATE" version="2.0">
|
||
<description>
|
||
Activate Call Forwarding Unconditional to the registered destination.
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="CFU_DEACTIVATE" version="2.0">
|
||
<description>
|
||
Deactivate Call Forwarding Unconditional to the registered destination.
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="CFU_ERASE" version="2.0">
|
||
<description>
|
||
Erase the registered Call Forwarding Unconditional Destination.
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="CFU_INTERROGATE" version="2.0">
|
||
<description>
|
||
Interrogate the registered Call Forwarding Unconditional Destination.
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="CLIR_ACTIVATE" version="2.0">
|
||
<description>
|
||
Activate Calling Line Identification Restriction (i.e. your calling number will be restricted).
|
||
Set the parameter {{param|.CallControl.CallingFeatures.Set.{i}.AnonymousCallEnable}} to {{true}}.
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="CLIR_DEACTIVATE" version="2.0">
|
||
<description>
|
||
Deactivate Calling Line Identification Restriction.
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="CLIR_INTERROGATE" version="2.0">
|
||
<description>
|
||
Interrogate the Calling Line Identification status.
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="CP_INVOKE" version="2.0">
|
||
<description>
|
||
Invoke Carrier Prefix. The prefix is prepended to the destination number. The facility argument will reference the Carrier Prefix
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="CW_ACTIVATE" version="2.0">
|
||
<description>
|
||
Activate Call Waiting.
|
||
Set the parameter {{param|.CallControl.CallingFeatures.Set.{i}.CallWaitingEnable}} to {{true}}.
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="CW_DEACTIVATE" version="2.0">
|
||
<description>
|
||
Deactivate Call Waiting
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="CW_INVOKE" version="2.0">
|
||
<description>
|
||
Used for answering a waiting call or switching between calls.
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="DND_ACTIVATE" version="2.0">
|
||
<description>
|
||
Activate Do Not Disturb on the extension.
|
||
Set the parameter {{param|.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.
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="DND_DEACTIVATE" version="2.0">
|
||
<description>
|
||
Deactivate Do Not Desturb.
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="DND_INTERROGATE" version="2.0">
|
||
<description>
|
||
Interrogate the status of Do Not Disturb.
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="EXT_INVOKE" version="2.0">
|
||
<description>
|
||
Invoke an extension. The extension referenced in the facility argument will be used as destination instead of the line defined in {{object|.CallControl.OutgoingMap.{i}.}}
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="LINE_INVOKE" version="2.0">
|
||
<description>
|
||
Invoke a line. The line referenced in the facility argument will be used for an outgoing call instead of the line defined in {{object|.CallControl.OutgoingMap.{i}.}}.
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="MAILBOX_INVOKE" version="2.0">
|
||
<description>
|
||
Invoke a mailbox. The interactive menu to listen and manipulate voicemail messages will be invoked.
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="OCB_ACTIVATE" version="2.0">
|
||
<description>
|
||
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.
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="OCB_DEACTIVATE" version="2.0">
|
||
<description>
|
||
Deactivate Outgoing Call Barring.
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="OCB_INTERROGATE" version="2.0">
|
||
<description>
|
||
Interrogate Outgoing Call Barring.
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="PSO_ACTIVATE" version="2.0">
|
||
<description>
|
||
Switch the call to a PSTN line.
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="PW_SET" version="2.0">
|
||
<description>
|
||
Set the password used for controlling access to the Facility Actions.
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="SCF_ACTIVATE" version="2.0">
|
||
<description>
|
||
Activate Selective Call Forwarding. This facility permits the user to forward calls to different destinations depending on the calling number : cf. table {{object|.CallControl.CallingFeatures.Set.{i}.SCF.{i}.}}
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="SCF_DEACTIVATE" version="2.0">
|
||
<description>
|
||
Deactivate Selective Call Forwarding.
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="SCF_INTERROGATE" version="2.0">
|
||
<description>
|
||
Interrogate the status of Selective Call Forwarding.
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="SCREJ_ACTIVATE" version="2.0">
|
||
<description>
|
||
Activate Selective Call Rejection. This facility permits the user to selectively reject calls depending on the calling number : cf. table {{object|.CallControl.CallingFeatures.Set.{i}.SCREJ.{i}.}}
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="SCREJ_DEACTIVATE" version="2.0">
|
||
<description>
|
||
Deactivate Selective Call Rejection.
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="SCREJ_INTERROGATE" version="2.0">
|
||
<description>
|
||
Interrogate the status of Selective Call Rejection.
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="SR_ACTIVATE" version="2.0">
|
||
<description>
|
||
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.
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="SR_DEACTIVATE" version="2.0">
|
||
<description>
|
||
Deactivate Selective Ringing.
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="SR_INTERROGATE" version="2.0">
|
||
<description>
|
||
Interrogate the status of Selective Ringing.
|
||
</description>
|
||
</enumeration>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="CodecNumberOfEntries" access="readOnly" version="2.0">
|
||
<description>
|
||
{{numentries}}
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.Capabilities.SIP." access="readOnly" minEntries="1" maxEntries="1" version="2.0">
|
||
<description>
|
||
SIP-specific capabilities (as defined in {{bibref|RFC3261}}).
|
||
</description>
|
||
</object>
|
||
<object name="VoiceService.{i}.Capabilities.SIP.Client." access="readOnly" minEntries="1" maxEntries="1" version="2.0">
|
||
<description>
|
||
SIP client capabilities.
|
||
</description>
|
||
<parameter name="Extensions" access="readOnly" version="2.0">
|
||
<description>
|
||
{{list}} Each item is a supported SIP extension method among the methods listed in the IANA SIP parameters registry (see {{bibref|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 {{bibref|TR-106}}.
|
||
Examples:
|
||
: "REFER"
|
||
: "INFO"
|
||
: "X_EXAMPLE-COM_MyExt"
|
||
</description>
|
||
<syntax>
|
||
<list/>
|
||
<string/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="URISchemes" access="readOnly" version="2.0">
|
||
<description>
|
||
{{list}} Each item is a supported URI scheme beyond the URI schemes REQUIRED by the SIP specification ({{bibref|RFC3261}}). Each URI scheme is given by the URI prefix, without the colon separator. Example:
|
||
"tel, fax"
|
||
</description>
|
||
<syntax>
|
||
<list/>
|
||
<string/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="EventTypes" access="readOnly" version="2.0">
|
||
<description>
|
||
{{list}} Each item is a supported event package among the event packages listed in the IANA registry for SIP Event Type Namespace (see {{bibref|IANA_Event_Packages}}).
|
||
The list MAY include vendor-specific event packages, which MUST use the format defined in {{bibref|TR-106}}.
|
||
Examples:
|
||
: "call-completion"
|
||
: "presence"
|
||
: "X_EXAMPLE-COM_MyEvtPkg"
|
||
</description>
|
||
<syntax>
|
||
<list/>
|
||
<string/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="TLSAuthenticationProtocols" access="readOnly" version="2.0">
|
||
<description>
|
||
{{list}} Each item is a supported authentication protocol for TLS transport. {{enum}}
|
||
The list MAY include vendor-specific protocols, which MUST use the format defined in {{bibref|TR-106}}.
|
||
</description>
|
||
<syntax>
|
||
<list/>
|
||
<string>
|
||
<enumeration value="Null" version="2.0"/>
|
||
<enumeration value="MD5" version="2.0"/>
|
||
<enumeration value="SHA-1" version="2.0"/>
|
||
<enumeration value="SHA-2" version="2.0"/>
|
||
<enumeration value="AEAD" version="2.0"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="TLSAuthenticationKeySizes" access="readOnly" version="2.0">
|
||
<description>
|
||
{{list}} Each item represents a supported TLS authentication key size.
|
||
</description>
|
||
<syntax>
|
||
<list/>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="TLSEncryptionProtocols" access="readOnly" version="2.0">
|
||
<description>
|
||
{{list}} Each item is a supported encryption protocol for TLS transport. {{enum}}
|
||
The list MAY include vendor-specific protocols, which MUST use the format defined in {{bibref|TR-106}}.
|
||
</description>
|
||
<syntax>
|
||
<list/>
|
||
<string>
|
||
<enumeration value="Null" version="2.0"/>
|
||
<enumeration value="RC4" version="2.0"/>
|
||
<enumeration value="RC2" version="2.0"/>
|
||
<enumeration value="DES" version="2.0"/>
|
||
<enumeration value="3DES" version="2.0"/>
|
||
<enumeration value="AES" version="2.0"/>
|
||
<enumeration value="Camellia" version="2.0"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="TLSEncryptionKeySizes" access="readOnly" version="2.0">
|
||
<description>
|
||
{{list}} Each item is a supported TLS encryption key size.
|
||
</description>
|
||
<syntax>
|
||
<list/>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="TLSKeyExchangeProtocols" access="readOnly" version="2.0">
|
||
<description>
|
||
{{list}} Each item is a supported key exchange protocol for TLS transport. {{enum}}
|
||
The list MAY include vendor-specific protocols, which MUST use the format defined in {{bibref|TR-106}}.
|
||
</description>
|
||
<syntax>
|
||
<list/>
|
||
<string>
|
||
<enumeration value="RSA" version="2.0"/>
|
||
<enumeration value="DSS" version="2.0"/>
|
||
<enumeration value="DHE-RSA" version="2.0"/>
|
||
<enumeration value="DHE-DSS" version="2.0"/>
|
||
<enumeration value="ECDHE-RSA" version="2.0"/>
|
||
<enumeration value="ECDHE-ECDSA" version="2.0"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.Capabilities.SIP.Registrar." access="readOnly" minEntries="1" maxEntries="1" version="2.0">
|
||
<description>
|
||
SIP registrar capabilities.
|
||
</description>
|
||
<parameter name="Extensions" access="readOnly" version="2.0">
|
||
<description>
|
||
{{list}} Each item is a supported SIP extension method among the methods listed in the IANA SIP parameters registry (see {{bibref|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 {{bibref|TR-106}}.
|
||
Examples:
|
||
: "REFER"
|
||
: "INFO"
|
||
: "X_EXAMPLE-COM_MyExt"
|
||
</description>
|
||
<syntax>
|
||
<list/>
|
||
<string/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="URISchemes" access="readOnly" version="2.0">
|
||
<description>
|
||
{{list}} 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"
|
||
</description>
|
||
<syntax>
|
||
<list/>
|
||
<string/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="EventTypes" access="readOnly" version="2.0">
|
||
<description>
|
||
{{list}} Each item is a supported event package among the event packages listed in the IANA registry for SIP Event Type Namespace (see {{bibref|IANA_Event_Packages}}).
|
||
The list MAY include vendor-specific event packages, which MUST use the format defined in {{bibref|TR-106}}.
|
||
Examples:
|
||
: "call-completion"
|
||
: "presence"
|
||
: "X_EXAMPLE-COM_MyEvtPkg"
|
||
</description>
|
||
<syntax>
|
||
<list/>
|
||
<string/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="TLSAuthenticationProtocols" access="readOnly" version="2.0">
|
||
<description>
|
||
{{list}} Each item is a supported authentication protocol for TLS transport. {{enum}}
|
||
The list MAY include vendor-specific protocols, which MUST use the format defined in {{bibref|TR-106}}.
|
||
</description>
|
||
<syntax>
|
||
<list/>
|
||
<string>
|
||
<enumeration value="Null" version="2.0"/>
|
||
<enumeration value="MD5" version="2.0"/>
|
||
<enumeration value="SHA-1" version="2.0"/>
|
||
<enumeration value="SHA-2" version="2.0"/>
|
||
<enumeration value="AEAD" version="2.0"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="TLSAuthenticationKeySizes" access="readOnly" version="2.0">
|
||
<description>
|
||
{{list}} Each item represents a supported TLS authentication key size.
|
||
</description>
|
||
<syntax>
|
||
<list/>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="TLSEncryptionProtocols" access="readOnly" version="2.0">
|
||
<description>
|
||
{{list}} Each item is a supported encryption protocol for TLS transport. {{enum}}
|
||
The list MAY include vendor-specific protocols, which MUST use the format defined in {{bibref|TR-106}}.
|
||
</description>
|
||
<syntax>
|
||
<list/>
|
||
<string>
|
||
<enumeration value="Null" version="2.0"/>
|
||
<enumeration value="RC4" version="2.0"/>
|
||
<enumeration value="RC2" version="2.0"/>
|
||
<enumeration value="DES" version="2.0"/>
|
||
<enumeration value="3DES" version="2.0"/>
|
||
<enumeration value="AES" version="2.0"/>
|
||
<enumeration value="Camellia" version="2.0"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="TLSEncryptionKeySizes" access="readOnly" version="2.0">
|
||
<description>
|
||
{{list}} Each item is a supported TLS encryption key size.
|
||
</description>
|
||
<syntax>
|
||
<list/>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="TLSKeyExchangeProtocols" access="readOnly" version="2.0">
|
||
<description>
|
||
{{list}} Each item is a supported key exchange protocol for TLS transport. {{enum}}
|
||
The list MAY include vendor-specific protocols, which MUST use the format defined in {{bibref|TR-106}}.
|
||
</description>
|
||
<syntax>
|
||
<list/>
|
||
<string>
|
||
<enumeration value="RSA" version="2.0"/>
|
||
<enumeration value="DSS" version="2.0"/>
|
||
<enumeration value="DHE-RSA" version="2.0"/>
|
||
<enumeration value="DHE-DSS" version="2.0"/>
|
||
<enumeration value="ECDHE-RSA" version="2.0"/>
|
||
<enumeration value="ECDHE-ECDSA" version="2.0"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.Capabilities.MGCP." access="readOnly" minEntries="1" maxEntries="1" version="2.0">
|
||
<description>
|
||
MGCP-specific capabilities (as defined in {{bibref|RFC3435}}).
|
||
</description>
|
||
<parameter name="Extensions" access="readOnly" version="2.0">
|
||
<description>
|
||
{{list}} 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 {{bibref|TR-106}}.
|
||
Examples:
|
||
: "BP"
|
||
: "X_EXAMPLE-COM_MyExt"
|
||
</description>
|
||
<syntax>
|
||
<list/>
|
||
<string/>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.Capabilities.H323." access="readOnly" minEntries="1" maxEntries="1" version="2.0">
|
||
<description>
|
||
H.323-specific capabilities (as defined in {{bibref|H.323}}).
|
||
</description>
|
||
<parameter name="FastStart" access="readOnly" version="2.0">
|
||
<description>
|
||
Support for H.323 fast start. If {{true}} indicates support for fast start.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="H235AuthenticationMethods" access="readOnly" version="2.0">
|
||
<description>
|
||
{{list}} Each item is a supported authentication method. {{enum}}
|
||
The list MAY include vendor-specific protocols, which MUST use the format defined in {{bibref|TR-106a7}}.
|
||
</description>
|
||
<syntax>
|
||
<list/>
|
||
<string>
|
||
<enumeration value="dhExch" version="2.0">
|
||
<description>
|
||
Diffie-Hellman
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="pwdSymEnc" version="2.0">
|
||
<description>
|
||
password with symmetric encryption
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="pwdHash" version="2.0">
|
||
<description>
|
||
password with hashing
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="certSign" version="2.0">
|
||
<description>
|
||
certificate with signature
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="ipsec" version="2.0">
|
||
<description>
|
||
IPsec based connection
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="tls" version="2.0">
|
||
<description>
|
||
TLS
|
||
</description>
|
||
</enumeration>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.Capabilities.ISDN." access="readOnly" minEntries="1" maxEntries="1" version="2.0">
|
||
<description>
|
||
The overall ISDN capabilities of external ports of the CPE.
|
||
</description>
|
||
<parameter name="MSN" access="readOnly" version="2.0">
|
||
<description>
|
||
The external ISDN ports support {{bibref|I.251.2}} Number identification supplementary services: Multiple Subscriber Number
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="DDI" access="readOnly" version="2.0">
|
||
<description>
|
||
The external ISDN ports support {{bibref|I.251.1}} Number identification supplementary services: Direct-dialling-In
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="MCID" access="readOnly" version="2.0">
|
||
<description>
|
||
The external ISDN ports support {{bibref|I.251.7}} Number identification supplementary services: Malicious call Identification
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="MWI" access="readOnly" version="2.0">
|
||
<description>
|
||
The external ISDN ports support Message Waiting Indication (MWI)
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="AoC" access="readOnly" version="2.0">
|
||
<description>
|
||
The external ISDN ports support one or more of the followings AOC-services:
|
||
{{bibref|I.256.2a}} Charging supplementary services: Advice of charge: charging information at call set-up time (AOC-S)
|
||
{{bibref|I.256.2b}} Charging supplementary services: Advice of charge: charging information during the call (AOC-D)
|
||
{{bibref|I.256.2c}} Charging supplementary services: Advice of charge: charging information at the end of the call (AOC-E)
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="ECT" access="readOnly" version="2.0">
|
||
<description>
|
||
The external ISDN ports support {{bibref|I.252.7}} Call offering supplementary services:
|
||
Explicit call transfer (ECT)
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.Capabilities.POTS." access="readOnly" minEntries="1" maxEntries="1" version="2.0">
|
||
<description>
|
||
The overall POTS capabilities of external ports of the CPE.
|
||
</description>
|
||
<parameter name="DialType" access="readOnly" version="2.0">
|
||
<description>
|
||
The supported supported dial type.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="Tone" version="2.0">
|
||
<description>
|
||
Supports Tone dialling
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="Pulse" version="2.0">
|
||
<description>
|
||
Supports Pulse dialling
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="Tone and Pulse" version="2.0">
|
||
<description>
|
||
Supports Tone and Pulse dialling
|
||
</description>
|
||
</enumeration>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="ClipGeneration" access="readOnly" version="2.0">
|
||
<description>
|
||
The external POTS ports support Calling Line identification (CLIP).
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="ChargingPulse" access="readOnly" version="2.0">
|
||
<description>
|
||
The external POTS ports support transmittal of a charging pulse according to TR1 TR 110.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.Capabilities.Codec.{i}." access="readOnly" numEntriesParameter="CodecNumberOfEntries" minEntries="0" maxEntries="unbounded" version="2.0">
|
||
<description>
|
||
Table to describe the set of supported codecs.
|
||
</description>
|
||
<uniqueKey functional="false">
|
||
<parameter ref="Alias"/>
|
||
</uniqueKey>
|
||
<uniqueKey>
|
||
<parameter ref="Codec"/>
|
||
<parameter ref="BitRate"/>
|
||
</uniqueKey>
|
||
<parameter name="Alias" access="readWrite" activeNotify="canDeny" version="2.0">
|
||
<description>
|
||
{{datatype|expand}}
|
||
</description>
|
||
<syntax>
|
||
<dataType ref="Alias"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Codec" access="readOnly" version="2.0">
|
||
<description>
|
||
Identifier of the type of codec. {{enum}}
|
||
The parameter MAY instead be a vendor-specific codec, which MUST be in the format defined in {{bibref|TR-106}}. For example:
|
||
"X_EXAMPLE-COM_MyCodec"
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="AMR" version="2.0"/>
|
||
<enumeration value="Clearmode" version="2.0">
|
||
<description>
|
||
RFC4040
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="EVRC1" version="2.0"/>
|
||
<enumeration value="EVRCB1" version="2.0"/>
|
||
<enumeration value="G.711MuLaw" version="2.0"/>
|
||
<enumeration value="G.711ALaw" version="2.0"/>
|
||
<enumeration value="G.726" version="2.0"/>
|
||
<enumeration value="G.729" version="2.0"/>
|
||
<enumeration value="G.729.1" version="2.0"/>
|
||
<enumeration value="G.729a" version="2.0"/>
|
||
<enumeration value="G.729e" version="2.0"/>
|
||
<enumeration value="G.728" version="2.0"/>
|
||
<enumeration value="G.723.1" version="2.0"/>
|
||
<enumeration value="G.722" version="2.0"/>
|
||
<enumeration value="G.722.1" version="2.0"/>
|
||
<enumeration value="G.722.2" version="2.0"/>
|
||
<enumeration value="Generic Comfort Noise" version="2.0">
|
||
<description>
|
||
RFC3389
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="GSM-FR" version="2.0"/>
|
||
<enumeration value="GSM-HR" version="2.0"/>
|
||
<enumeration value="GSM-EFR" version="2.0"/>
|
||
<enumeration value="iLBC" version="2.0"/>
|
||
<enumeration value="Speex" version="2.0"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="BitRate" access="readOnly" version="2.0">
|
||
<description>
|
||
Bit rate, specified in {{units}}. The value MUST be among the values appropriate for the specified codec.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<units value="bits per second"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="PacketizationPeriod" access="readOnly" version="2.0">
|
||
<description>
|
||
{{list}} 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.
|
||
</description>
|
||
<syntax>
|
||
<list/>
|
||
<string>
|
||
<size maxLength="64"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="SilenceSuppression" access="readOnly" version="2.0">
|
||
<description>
|
||
If {{true}} indicates support for silence suppression for this codec.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.Capabilities.QualityIndicator." access="readOnly" minEntries="1" maxEntries="1" version="2.0">
|
||
<description>
|
||
Specific capabilities concerning quality indicators.
|
||
</description>
|
||
<parameter name="QIModelsSupported" access="readOnly" version="2.0">
|
||
<description>
|
||
Comma-separated list of supported models for evaluation of VoIP Quality Indicator. {{empty}} 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 {{bibref|TR-106}}.
|
||
For example: “P.564,G.107,X_EXAMPLE-COM_MyModel”
|
||
</description>
|
||
<syntax>
|
||
<string/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="MaxQIValues" access="readOnly" version="2.0">
|
||
<description>
|
||
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.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<range minInclusive="0" maxInclusive="127"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="MaxWorstQIValues" access="readOnly" version="2.0">
|
||
<description>
|
||
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.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<range minInclusive="0" maxInclusive="127"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.ReservedPorts." access="readOnly" minEntries="1" maxEntries="1" version="2.0">
|
||
<description>
|
||
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.
|
||
</description>
|
||
<parameter name="WANPortRange" access="readWrite" version="2.0">
|
||
<description>
|
||
Range of ports reserved for use by the CPE on any WAN interface. {{list}} 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
|
||
</description>
|
||
<syntax>
|
||
<list/>
|
||
<string/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="LANPortRange" access="readWrite" version="2.0">
|
||
<description>
|
||
Range of ports reserved for use by the CPE on any LAN interfaces. {{list}} 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
|
||
</description>
|
||
<syntax>
|
||
<list/>
|
||
<string/>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.ISDN." access="readOnly" minEntries="1" maxEntries="1" version="2.0">
|
||
<description>
|
||
This object models ISDN physical interfaces (BRI and PRI) supporting {{bibref|Q.931}} based signalling.
|
||
</description>
|
||
<parameter name="BRINumberOfEntries" access="readOnly" version="2.0">
|
||
<description>
|
||
{{numentries}}
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="PRINumberOfEntries" access="readOnly" version="2.0">
|
||
<description>
|
||
{{numentries}}
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.ISDN.BRI.{i}." access="readOnly" numEntriesParameter="BRINumberOfEntries" minEntries="0" maxEntries="unbounded" version="2.0">
|
||
<description>
|
||
ISDN BRI physical interfaces table (a voice physical interface as described in {{bibref|TR-104i2|Section 4.1}}).
|
||
</description>
|
||
<uniqueKey functional="false">
|
||
<parameter ref="Name"/>
|
||
</uniqueKey>
|
||
<uniqueKey functional="false">
|
||
<parameter ref="Alias"/>
|
||
</uniqueKey>
|
||
<parameter name="Enable" access="readWrite" version="2.0">
|
||
<description>
|
||
Enables or disables this ISDN BRI interface.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Status" access="readOnly" version="2.0">
|
||
<description>
|
||
Indicates the status of this physical interface.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="Up" version="2.0"/>
|
||
<enumeration value="Error" version="2.0"/>
|
||
<enumeration value="Testing" version="2.0"/>
|
||
<enumeration value="Disabled" version="2.0"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Alias" access="readWrite" activeNotify="canDeny" version="2.0">
|
||
<description>
|
||
{{datatype|expand}}
|
||
</description>
|
||
<syntax>
|
||
<dataType ref="Alias"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Name" access="readOnly" version="2.0">
|
||
<description>
|
||
The textual name of the interface as assigned by the CPE.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="64"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="ToneEventProfile" access="readWrite" version="2.0">
|
||
<description>
|
||
Reference to the {{object|.Tone.EventProfile}} to use with this interface. If this parameter is {{empty}}, the value of {{param|.Tone.DefautEventProfile}} is used instead.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="256"/>
|
||
<pathRef refType="strong" targetParent=".Tone.EventProfile." targetType="row"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="ApplicationInterface" access="readWrite" version="2.0">
|
||
<description>
|
||
Specify the type of application that uses the interface.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="VoIP" version="2.0"/>
|
||
<enumeration value="VoATM" version="2.0"/>
|
||
<enumeration value="Data" version="2.0"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Protocol" access="readWrite" version="2.0">
|
||
<description>
|
||
Specifies the protocol variant used for the interface. {{enum}}
|
||
The list MAY include vendor-specific protocols, which MUST use the format defined in {{bibref|TR-106}}.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="EuroISDN" version="2.0">
|
||
<description>
|
||
ETSI defined Euro ISDN (DSS1)
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="NI-1" version="2.0">
|
||
<description>
|
||
National ISDN-1 (Bellcore)
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="NI-2" version="2.0">
|
||
<description>
|
||
National ISDN-2 (Bellcore))
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="5ESS" version="2.0">
|
||
<description>
|
||
AT&T ISDN
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="NTT" version="2.0">
|
||
<description>
|
||
Japanese NTT ISDN
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="VN3" version="2.0">
|
||
<description>
|
||
French VN3 ISDN
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="VN4" version="2.0">
|
||
<description>
|
||
French VN4 ISDN
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="Q.SIG" version="2.0"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="ProtocolEmulation" access="readWrite" version="2.0">
|
||
<description>
|
||
Protocol emulation for the interface.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="TE" version="2.0"/>
|
||
<enumeration value="NT" version="2.0"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="PermanentLayer2" access="readWrite" version="2.0">
|
||
<description>
|
||
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.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="PermanentLayer1" access="readWrite" version="2.0">
|
||
<description>
|
||
Maintain the ISDN layer 1 up; it is useful for clocking and management.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="LapdDisconnectionTimeout" access="readWrite" version="2.0">
|
||
<description>
|
||
Avoid the disconnection of the ISDN layer 1 or 2 up when there is no call in progress in dynamic TEI mode.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="TEINegotiation" access="readWrite" version="2.0">
|
||
<description>
|
||
TEI management mode. It MUST be set to {{enum|Dynamic}} for ISDN phones or connection to an ISDN network and {{enum|Static}} for PBX.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="Static" version="2.0"/>
|
||
<enumeration value="Dynamic" version="2.0"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="StaticTEI" access="readWrite" version="2.0">
|
||
<description>
|
||
TEI value in static mode.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<range maxInclusive="63"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="LifeLineHold" access="readWrite" version="2.0">
|
||
<description>
|
||
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.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="PowerSourceOne" access="readWrite" version="2.0">
|
||
<description>
|
||
To enable (disable) the power source one (PS1) on the BRI interfaces.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="MaxNumBChannels" access="readWrite" version="2.0">
|
||
<description>
|
||
Maximum number of simultaneous B channels.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<range maxInclusive="2"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="OutboundOnlyBChannels" access="readWrite" version="2.0">
|
||
<description>
|
||
{{list|reserved B-channels which can be used only for outbound calls}}
|
||
</description>
|
||
<syntax>
|
||
<list/>
|
||
<unsignedInt>
|
||
<range minInclusive="1" maxInclusive="2"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="InboundOnlyBChannels" access="readWrite" version="2.0">
|
||
<description>
|
||
{{list|reserved B-channels which can be used only for inbound calls}}
|
||
</description>
|
||
<syntax>
|
||
<list/>
|
||
<unsignedInt>
|
||
<range minInclusive="1" maxInclusive="2"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="BidirectionalBChannels" access="readWrite" version="2.0">
|
||
<description>
|
||
{{list|reserved B-channels which can be used bidirectional}}
|
||
</description>
|
||
<syntax>
|
||
<list/>
|
||
<unsignedInt>
|
||
<range minInclusive="1" maxInclusive="2"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.ISDN.PRI.{i}." access="readOnly" numEntriesParameter="PRINumberOfEntries" minEntries="0" maxEntries="unbounded" version="2.0">
|
||
<description>
|
||
ISDN PRI physical interfaces table (a voice physical interface as described in {{bibref|TR-104i2|Section 4.1}}).
|
||
</description>
|
||
<uniqueKey functional="false">
|
||
<parameter ref="Name"/>
|
||
</uniqueKey>
|
||
<uniqueKey functional="false">
|
||
<parameter ref="Alias"/>
|
||
</uniqueKey>
|
||
<parameter name="Enable" access="readWrite" version="2.0">
|
||
<description>
|
||
Enables or disables this ISDN PRI interface.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Status" access="readOnly" version="2.0">
|
||
<description>
|
||
Indicates the status of this physical interface.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="Up" version="2.0"/>
|
||
<enumeration value="Error" version="2.0"/>
|
||
<enumeration value="Testing" version="2.0"/>
|
||
<enumeration value="Disabled" version="2.0"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Alias" access="readWrite" activeNotify="canDeny" version="2.0">
|
||
<description>
|
||
{{datatype|expand}}
|
||
</description>
|
||
<syntax>
|
||
<dataType ref="Alias"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Name" access="readOnly" version="2.0">
|
||
<description>
|
||
The textual name of the interface as assigned by the CPE.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="64"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="ToneEventProfile" access="readWrite" version="2.0">
|
||
<description>
|
||
Reference to the {{object|.Tone.EventProfile}} to use with this interface. If this parameter is {{empty}}, the value of {{param|.Tone.DefautEventProfile}} is used instead.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="256"/>
|
||
<pathRef refType="strong" targetParent=".Tone.EventProfile." targetType="row"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="ApplicationInterface" access="readWrite" version="2.0">
|
||
<description>
|
||
Specify the type of application that uses the interface.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="VoIP" version="2.0"/>
|
||
<enumeration value="VoATM" version="2.0"/>
|
||
<enumeration value="Data" version="2.0"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Protocol" access="readWrite" version="2.0">
|
||
<description>
|
||
Specifies the protocol variant used for the interface. {{enum}}
|
||
The list MAY include vendor-specific protocols, which MUST use the format defined in {{bibref|TR-106}}.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="EuroISDN" version="2.0">
|
||
<description>
|
||
ETSI defined Euro ISDN (DSS1, E-DSS1)
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="NI-1" version="2.0">
|
||
<description>
|
||
National ISDN-1 (Bellcore)
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="NI-2" version="2.0">
|
||
<description>
|
||
National ISDN-2 (Bellcore))
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="4ESS" version="2.0">
|
||
<description>
|
||
AT&T 4ESS ISDN
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="5ESS" version="2.0">
|
||
<description>
|
||
AT&T 5ESS ISDN
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="NTT" version="2.0">
|
||
<description>
|
||
Japanese INS-NET1500 ISDN
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="Q.SIG" version="2.0"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="ProtocolEmulation" access="readWrite" version="2.0">
|
||
<description>
|
||
Specify the protocol emulation for this interface.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="TE" version="2.0"/>
|
||
<enumeration value="NT" version="2.0"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="PermanentLayer2" access="readWrite" version="2.0">
|
||
<description>
|
||
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.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Linecode" access="readWrite" version="2.0">
|
||
<description>
|
||
Specify the physical line coding to be used.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="ami" version="2.0"/>
|
||
<enumeration value="hdb3" version="2.0"/>
|
||
<enumeration value="b8zs" version="2.0"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="ESF" access="readWrite" version="2.0">
|
||
<description>
|
||
Specify the framing type.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="None" version="2.0">
|
||
<description>
|
||
no framing. Only used for CES / unstructured mode
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="DF" version="2.0">
|
||
<description>
|
||
double frame, no CRC4. For E1 only
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="MF" version="2.0">
|
||
<description>
|
||
multiframe (CRC4). For E1 only
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="EMF" version="2.0">
|
||
<description>
|
||
extended multiframe (CRC4). For E1 only
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="SF" version="2.0">
|
||
<description>
|
||
super-frame. For T1 only
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="ESF" version="2.0">
|
||
<description>
|
||
extended super frame. For T1 only
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="AutoDetect" version="2.0">
|
||
<description>
|
||
used to find automatically ISDN PRI framing by trying all possible detections. This behavior can be set when the configuration of remote
|
||
</description>
|
||
</enumeration>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="PhysicalInterfaceType" access="readWrite" version="2.0">
|
||
<description>
|
||
{{enum}}
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="T1" version="2.0"/>
|
||
<enumeration value="E1" version="2.0"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="MaxNumBChannels" access="readWrite" version="2.0">
|
||
<description>
|
||
Maximum number of simultaneous B channels.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<range maxInclusive="30"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="OutboundOnlyBChannels" access="readWrite" version="2.0">
|
||
<description>
|
||
{{list|reserved B-channels which can be used only for outbound calls}}
|
||
</description>
|
||
<syntax>
|
||
<list/>
|
||
<unsignedInt>
|
||
<range minInclusive="0" maxInclusive="31"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="InboundOnlyBChannels" access="readWrite" version="2.0">
|
||
<description>
|
||
{{list|reserved B-channels which can be used only for inbound calls}}
|
||
</description>
|
||
<syntax>
|
||
<list/>
|
||
<unsignedInt>
|
||
<range minInclusive="0" maxInclusive="31"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="BidirectionalBChannels" access="readWrite" version="2.0">
|
||
<description>
|
||
{{list|reserved B-channels which can be used bidirectional}}
|
||
</description>
|
||
<syntax>
|
||
<list/>
|
||
<unsignedInt>
|
||
<range minInclusive="0" maxInclusive="31"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="ClockMode" access="readWrite" version="2.0">
|
||
<description>
|
||
Determines the role of the CPE for the purpose of clock synchronisation on this interface.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="Master" version="2.0"/>
|
||
<enumeration value="Slave" version="2.0"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.POTS." access="readOnly" minEntries="1" maxEntries="1" version="2.0">
|
||
<description>
|
||
This object models analogue lines. Both FXO and FXS are handled.
|
||
</description>
|
||
<parameter name="FXONumberOfEntries" access="readOnly" version="2.0">
|
||
<description>
|
||
{{numentries}}
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="FXSNumberOfEntries" access="readOnly" version="2.0">
|
||
<description>
|
||
{{numentries}}
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Region" access="readWrite" version="2.0">
|
||
<description>
|
||
The geographic region associated to POTS (MUST be an alpha-2 (two-character alphabetic) country code as specified by {{bibref|ISO3166-1}}). This MAY be used by the CPE to customize localization settings.
|
||
If {{empty}}, indicates that the region is unspecified and the CPE SHOULD use default localization settings.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="2"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.POTS.FXO.{i}." access="readOnly" numEntriesParameter="FXONumberOfEntries" minEntries="0" maxEntries="unbounded" version="2.0">
|
||
<description>
|
||
FXO physical interfaces table (a voice physical interface as described in {{bibref|TR-104i2|Section 4.1}}).
|
||
Each entry in the table models an analogue physical interface as defined by {{bibref|ETSI_ES_203_021}}
|
||
</description>
|
||
<uniqueKey functional="false">
|
||
<parameter ref="Name"/>
|
||
</uniqueKey>
|
||
<uniqueKey functional="false">
|
||
<parameter ref="Alias"/>
|
||
</uniqueKey>
|
||
<parameter name="Enable" access="readWrite" version="2.0">
|
||
<description>
|
||
Enables or disables this FXO interface.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Status" access="readOnly" version="2.0">
|
||
<description>
|
||
Indicates the status of this physical interface.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="Up" version="2.0"/>
|
||
<enumeration value="Error" version="2.0"/>
|
||
<enumeration value="Testing" version="2.0"/>
|
||
<enumeration value="Disabled" version="2.0"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Alias" access="readWrite" activeNotify="canDeny" version="2.0">
|
||
<description>
|
||
{{datatype|expand}}
|
||
</description>
|
||
<syntax>
|
||
<dataType ref="Alias"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Name" access="readOnly" version="2.0">
|
||
<description>
|
||
The textual name of the interface as assigned by the CPE.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="64"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="ToneEventProfile" access="readWrite" version="2.0">
|
||
<description>
|
||
Reference to the {{object|.Tone.EventProfile}} to use with this interface. If this parameter is {{empty}}, the value of {{param|.Tone.DefautEventProfile}} is used instead.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="256"/>
|
||
<pathRef refType="strong" targetParent=".Tone.EventProfile." targetType="row"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="SecondStepDialing" access="readWrite" version="2.0">
|
||
<description>
|
||
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.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
<default type="factory" value="false"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="TimeoutBeforeDialing" access="readWrite" version="2.0">
|
||
<description>
|
||
Specifies the time in {{units}} between off-hook and the transmission of the first digit for FXO interface.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<range minInclusive="1" maxInclusive="60"/>
|
||
<units value="seconds"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="RingingTimeout" access="readWrite" version="2.0">
|
||
<description>
|
||
Defines the timeout in {{units}} 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.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<range minInclusive="1" maxInclusive="30"/>
|
||
<units value="seconds"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="RingNumber" access="readWrite" version="2.0">
|
||
<description>
|
||
Defines the number of pulses for ringing signal detection on FXO port.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<range minInclusive="1" maxInclusive="40"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="OnHookMinDuration" access="readWrite" version="2.0">
|
||
<description>
|
||
Specify the minimum duration in {{units}} of the "on-hook" state between two successive calls.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<range minInclusive="20" maxInclusive="10000"/>
|
||
<units value="milliseconds"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="SignalingMode" access="readWrite" version="2.0">
|
||
<description>
|
||
Signaling mode used for line seizure by the CPE.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="LoopStart" version="2.0"/>
|
||
<enumeration value="GroundStart" version="2.0"/>
|
||
</string>
|
||
<default type="factory" value="LoopStart"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="DTMFDialoutInterval" access="readWrite" version="2.0">
|
||
<description>
|
||
The time interval in {{units}} between dialing DTMF digits to PSTN. See also {{bibref|ETSI_ES_203_021}}
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<range minInclusive="20" maxInclusive="10000"/>
|
||
<units value="milliseconds"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="CallerIdDetectionEnable" access="readWrite" version="2.0">
|
||
<description>
|
||
Enables the detection of CallerId for incoming calls. See also {{bibref|ETSI_ES_203_021}}.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Active" access="readOnly" version="2.0">
|
||
<description>
|
||
Determines if this physical interface is plugged.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
</syntax>
|
||
</parameter>
|
||
<command name="DiagTests()" async="true" version="2.0">
|
||
<description>
|
||
This command provides access to an FXO Port tests.
|
||
</description>
|
||
<input>
|
||
<description>
|
||
Input arguments.
|
||
</description>
|
||
<parameter name="TestSelector" version="2.0">
|
||
<description>
|
||
Indicates which test to perform. {{enum}}
|
||
The parameter MAY instead indicate a vendor-specific test, which MUST use the format defined in {{bibref|TR-106}}. For example: "X_EXAMPLE-COM_MyTest"
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="Battery" version="2.0">
|
||
<description>
|
||
Tests for the presence of loop feed current; for a ''ground start'' line, also tests for polarity, to detect reversal of Tip and Ring
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="DialTone" version="2.0">
|
||
<description>
|
||
Closes the loop and checks for the presence of a dial tone.
|
||
</description>
|
||
</enumeration>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
</input>
|
||
<output>
|
||
<description>
|
||
Output arguments.
|
||
</description>
|
||
<parameter name="Status" version="2.0">
|
||
<description>
|
||
Indicates the availability of diagnostics data. {{enum}}
|
||
If the value of this parameter is anything other than {{enum|Complete}}, the values of the other results parameters for this test are indeterminate.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="Canceled" optional="true" version="2.0"/>
|
||
<enumeration value="Complete" version="2.0"/>
|
||
<enumeration value="Error" optional="true" version="2.0"/>
|
||
<enumeration value="Error_Internal" version="2.0"/>
|
||
<enumeration value="Error_Other" version="2.0"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="TestResult" version="2.0">
|
||
<description>
|
||
Result of the selected test. {{enum}}
|
||
The parameter MAY instead indicate a vendor-specific result, which MUST use the format defined in {{bibref|TR-106}}. For example: "X_EXAMPLE-COM_MyResult"
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="Success" version="2.0"/>
|
||
<enumeration value="Failure" version="2.0"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
</output>
|
||
</command>
|
||
</object>
|
||
<object name="VoiceService.{i}.POTS.FXS.{i}." access="readOnly" numEntriesParameter="FXSNumberOfEntries" minEntries="0" maxEntries="unbounded" version="2.0">
|
||
<description>
|
||
FXS physical interfaces table (a voice physical interface as described in {{bibref|TR-104i2|Section 4.1}}).
|
||
Each entry in the table models an analogue physical interface as defined by {{bibref|ETSI_ES_201_970}}
|
||
</description>
|
||
<uniqueKey functional="false">
|
||
<parameter ref="Name"/>
|
||
</uniqueKey>
|
||
<uniqueKey functional="false">
|
||
<parameter ref="Alias"/>
|
||
</uniqueKey>
|
||
<parameter name="Enable" access="readWrite" version="2.0">
|
||
<description>
|
||
Enables or disables this FXS interface.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Status" access="readOnly" version="2.0">
|
||
<description>
|
||
Indicates the status of this physical interface.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="Up" version="2.0"/>
|
||
<enumeration value="Error" version="2.0"/>
|
||
<enumeration value="Testing" version="2.0"/>
|
||
<enumeration value="Disabled" version="2.0"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Alias" access="readWrite" activeNotify="canDeny" version="2.0">
|
||
<description>
|
||
{{datatype|expand}}
|
||
</description>
|
||
<syntax>
|
||
<dataType ref="Alias"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Name" access="readOnly" version="2.0">
|
||
<description>
|
||
The textual name of the interface as assigned by the CPE.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="64"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="ToneEventProfile" access="readWrite" version="2.0">
|
||
<description>
|
||
Reference to the {{object|.Tone.EventProfile}} to use with this interface. If this parameter is {{empty}}, the value of {{param|.Tone.DefautEventProfile}} is used instead.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="256"/>
|
||
<pathRef refType="strong" targetParent=".Tone.EventProfile." targetType="row"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="FaxPassThrough" access="readWrite" version="2.0">
|
||
<description>
|
||
Indicates the support for pass-through of fax data of this interface. {{enum}}
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="Disable" version="2.0">
|
||
<description>
|
||
Prevents the CPE from switching to a fax pass-through mode.
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="Auto" version="2.0">
|
||
<description>
|
||
Allows the CPE to automatically detect fax data to determine whether or not to switch to a fax pass-through mode.
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="Force" version="2.0">
|
||
<description>
|
||
Forces the CPE to switch to a fax pass-through mode regardless of whether fax signaling is detected.
|
||
</description>
|
||
</enumeration>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="ModemPassThrough" access="readWrite" version="2.0">
|
||
<description>
|
||
Indicates the support for pass-through of modem data of this interface. {{enum}}
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="Disable" version="2.0">
|
||
<description>
|
||
Prevents the CPE from switching to a modem pass-through mode.
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="Auto" version="2.0">
|
||
<description>
|
||
Allows the CPE to automatically detect modem data to determine whether or not to switch to a modem pass-through mode.
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="Force" version="2.0">
|
||
<description>
|
||
Forces the CPE to switch to a modem pass-through mode regardless of whether modem signaling is detected.
|
||
</description>
|
||
</enumeration>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="DialType" access="readWrite" version="2.0">
|
||
<description>
|
||
Dial type used on the line.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="Tone" version="2.0">
|
||
<description>
|
||
Set the dial type to Tone dialling
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="Pulse" version="2.0">
|
||
<description>
|
||
Set the dial type to Pulse dialling
|
||
</description>
|
||
</enumeration>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="ClipGeneration" access="readWrite" version="2.0">
|
||
<description>
|
||
Whether the Calling Line identification (CLIP) is enabled.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="ChargingPulse" access="readWrite" version="2.0">
|
||
<description>
|
||
Whether a charging pulse is transmitted on the line.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Active" access="readOnly" version="2.0">
|
||
<description>
|
||
Indicates whether a terminal is plugged on this physical interface.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="TerminalType" access="readWrite" version="2.0">
|
||
<description>
|
||
Defines the terminal type plugged on this interface to determine the correct signaling to be used to contact the terminal.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="Audio" version="2.0"/>
|
||
<enumeration value="Fax" version="2.0"/>
|
||
<enumeration value="Modem" version="2.0"/>
|
||
<enumeration value="Any" version="2.0"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<command name="DiagTests()" async="true" version="2.0">
|
||
<description>
|
||
This command provides access to an FXS Port tests.
|
||
</description>
|
||
<input>
|
||
<description>
|
||
Input arguments.
|
||
</description>
|
||
<parameter name="TestSelector" version="2.0">
|
||
<description>
|
||
Indicates which GR-909 test to perform.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="Hazard Potential" version="2.0">
|
||
<description>
|
||
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
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="Foreign Voltage" version="2.0">
|
||
<description>
|
||
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
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="Resistive Faults" version="2.0">
|
||
<description>
|
||
Resistive Faults test is failed if a TIP-RING, TIP-GND or RING-GND on-hook DC resistance less than 150 k?
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="Off-hook" version="2.0">
|
||
<description>
|
||
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
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="REN" version="2.0">
|
||
<description>
|
||
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
|
||
</description>
|
||
</enumeration>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
</input>
|
||
<output>
|
||
<description>
|
||
Output arguments.
|
||
</description>
|
||
<parameter name="Status" version="2.0">
|
||
<description>
|
||
Indicates the availability of diagnostics data. {{enum}}
|
||
If the value of this parameter is anything other than {{enum|Complete}}, the values of the other results parameters for this test are indeterminate.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="Canceled" optional="true" version="2.0"/>
|
||
<enumeration value="Complete" version="2.0"/>
|
||
<enumeration value="Error" optional="true" version="2.0"/>
|
||
<enumeration value="Error_Internal" version="2.0"/>
|
||
<enumeration value="Error_Other" version="2.0"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="TestResult" version="2.0">
|
||
<description>
|
||
Result of the selected test.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="Success" version="2.0"/>
|
||
<enumeration value="Failure" version="2.0"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
</output>
|
||
</command>
|
||
</object>
|
||
<object name="VoiceService.{i}.POTS.FXS.{i}.VoiceProcessing." access="readOnly" minEntries="1" maxEntries="1" version="2.0">
|
||
<description>
|
||
Parameters related to voice processing (analogue/digital conversion) capabilities.
|
||
</description>
|
||
<parameter name="TransmitGain" access="readWrite" version="2.0">
|
||
<description>
|
||
Gain in {{units}} to apply to the transmitted voice signal prior to encoding. This gain is a modifier of the default transmit-gain, which is unspecified.
|
||
</description>
|
||
<syntax>
|
||
<int>
|
||
<units value="0.1 dB"/>
|
||
</int>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="ReceiveGain" access="readWrite" version="2.0">
|
||
<description>
|
||
Gain in {{units}} to apply to the received voice signal after decoding. This gain is a modifier of the default receive-gain, which is unspecified.
|
||
</description>
|
||
<syntax>
|
||
<int>
|
||
<units value="0.1 dB"/>
|
||
</int>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="EchoCancellationEnable" access="readWrite" version="2.0">
|
||
<description>
|
||
Enable or disable echo cancellation for this line.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="EchoCancellationInUse" access="readOnly" version="2.0">
|
||
<description>
|
||
Indication of whether or not echo cancellation is currently in use for this line.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="EchoCancellationTail" access="readOnly" version="2.0">
|
||
<description>
|
||
Tail length in {{units}} of the echo canceller associated with this line (whether or not it is currently in use).
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<units value="milliseconds"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.POTS.Ringer." access="readOnly" minEntries="1" maxEntries="1" version="2.0">
|
||
<description>
|
||
This object contains the ring sequences configured for analogue lines.
|
||
</description>
|
||
<parameter name="EventNumberOfEntries" access="readOnly" version="2.0">
|
||
<description>
|
||
{{numentries}}
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.POTS.Ringer.Event.{i}." access="readOnly" numEntriesParameter="EventNumberOfEntries" minEntries="0" maxEntries="unbounded" version="2.0">
|
||
<description>
|
||
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.
|
||
</description>
|
||
<uniqueKey functional="false">
|
||
<parameter ref="Alias"/>
|
||
</uniqueKey>
|
||
<uniqueKey>
|
||
<parameter ref="Function"/>
|
||
</uniqueKey>
|
||
<parameter name="Alias" access="readWrite" activeNotify="canDeny" version="2.0">
|
||
<description>
|
||
{{datatype|expand}}
|
||
</description>
|
||
<syntax>
|
||
<dataType ref="Alias"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Function" access="readOnly" version="2.0">
|
||
<description>
|
||
The event for which the ring pattern is to apply. {{enum}}
|
||
The parameter MAY instead indicate a vendor-specific event name, which MUST use the format defined in {{bibref|TR-106}}.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="Default" version="2.0"/>
|
||
<enumeration value="CCBSCallBack" version="2.0"/>
|
||
<enumeration value="CCNRCallBack" version="2.0"/>
|
||
<enumeration value="InternalCall" version="2.0"/>
|
||
<enumeration value="RingSplash" version="2.0"/>
|
||
<enumeration value="Group" version="2.0">
|
||
<description>
|
||
Used when the FXS is being alerted as part of a call to an {{object|.CallControl.Group.{i}}}
|
||
</description>
|
||
</enumeration>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Cadence" access="readWrite" version="2.0">
|
||
<description>
|
||
{{list}} The values represent an alternating pattern of times (in {{units}}) when the ringer is ON or OFF.
|
||
Example: "1000,5000"
|
||
See also {{bibref|ETSI_TR_101_183}}.
|
||
</description>
|
||
<syntax>
|
||
<list maxItems="10"/>
|
||
<unsignedInt>
|
||
<units value="milliseconds"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.DECT." access="readOnly" minEntries="1" maxEntries="1" version="2.0">
|
||
<description>
|
||
This object models DECT bases and portables.
|
||
</description>
|
||
<parameter name="BaseNumberOfEntries" access="readOnly" version="2.0">
|
||
<description>
|
||
{{numentries}}
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="PortableNumberOfEntries" access="readOnly" version="2.0">
|
||
<description>
|
||
{{numentries}}
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.DECT.Base.{i}." access="readOnly" numEntriesParameter="BaseNumberOfEntries" minEntries="0" maxEntries="unbounded" version="2.0">
|
||
<description>
|
||
DECT base table (a voice physical interface as described in {{bibref|TR-104i2|Section 4.1}}).
|
||
</description>
|
||
<uniqueKey>
|
||
<parameter ref="RFPI"/>
|
||
</uniqueKey>
|
||
<uniqueKey functional="false">
|
||
<parameter ref="Name"/>
|
||
</uniqueKey>
|
||
<uniqueKey functional="false">
|
||
<parameter ref="Alias"/>
|
||
</uniqueKey>
|
||
<parameter name="Enable" access="readWrite" version="2.0">
|
||
<description>
|
||
Enables or disables this base.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Status" access="readOnly" version="2.0">
|
||
<description>
|
||
Indicates the status of this base.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="Up" version="2.0"/>
|
||
<enumeration value="Error" version="2.0"/>
|
||
<enumeration value="Testing" version="2.0"/>
|
||
<enumeration value="Disabled" version="2.0"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Alias" access="readWrite" activeNotify="canDeny" version="2.0">
|
||
<description>
|
||
{{datatype|expand}}
|
||
</description>
|
||
<syntax>
|
||
<dataType ref="Alias"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Name" access="readOnly" version="2.0">
|
||
<description>
|
||
The textual name of the interface as assigned by the CPE.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="64"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="ToneEventProfile" access="readWrite" version="2.0">
|
||
<description>
|
||
Reference to the {{object|.Tone.EventProfile}} to use with this interface. If this parameter is {{empty}}, the value of {{param|.Tone.DefautEventProfile}} is used instead.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="256"/>
|
||
<pathRef refType="strong" targetParent=".Tone.EventProfile." targetType="row"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Standard" access="readOnly" version="2.0">
|
||
<description>
|
||
The highest DECT protocol version supported by the base.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="GAP" version="2.0">
|
||
<description>
|
||
see {{bibref|ETSI_EN_300_444}}
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="CAT-iq 1.0" version="2.0">
|
||
<description>
|
||
see {{bibref|ETSI_TS_102_527-1}}
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="CAT-iq 2.0" version="2.0">
|
||
<description>
|
||
see {{bibref|ETSI_TS_102_527-3}}
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="CAT-iq 2.1" version="2.0">
|
||
<description>
|
||
see {{bibref|ETSI_TS_102_527-5}}
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="CAT-iq 3.0" version="2.0">
|
||
<description>
|
||
see {{bibref|ETSI_TS_102_527-4}}
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="CAT-iq 4.0" version="2.0"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="RFPI" access="readOnly" version="2.0">
|
||
<description>
|
||
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 {{bibref|ETSI_EN_300_175-6|sections 5.1 to 5.5}}.
|
||
</description>
|
||
<syntax>
|
||
<hexBinary>
|
||
<size maxLength="5"/>
|
||
</hexBinary>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="MaxSupportedPP" access="readWrite" version="2.0">
|
||
<description>
|
||
The maximum number of Portable Parts (PP) supported by the DECT base of the CPE.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="PIN" access="readWrite" version="2.0">
|
||
<description>
|
||
The PIN is an hexbinary string of 32 bits, as defined in {{bibref|ETSI_TS_102_527-3}}.
|
||
</description>
|
||
<syntax hidden="true">
|
||
<hexBinary>
|
||
<size maxLength="4"/>
|
||
</hexBinary>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="RepeaterSupportEnabled" access="readOnly" version="2.0">
|
||
<description>
|
||
If {{true}}, the DECT system supports the REP feature, as defined in {{bibref|ETSI_EN_300_175-8}}.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="NEMOEnable" access="readWrite" version="2.0">
|
||
<description>
|
||
Enable or disable NEMO (No Emission Mode as defined in {{bibref|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.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="SubscriptionEnable" access="readWrite" version="2.0">
|
||
<description>
|
||
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).
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="CipheringEnable" access="readWrite" version="2.0">
|
||
<description>
|
||
Enable or disable ciphering for the calls on the DECT domain.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="EncryptionType" access="readOnly" version="2.0">
|
||
<description>
|
||
Algorithm used in the encryption process defined in {{bibref|ETSI_EN_300_175-7}}.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="DSC" version="2.0">
|
||
<description>
|
||
DECT Standard Cipher
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="DSC2" version="2.0">
|
||
<description>
|
||
DECT Standard Cipher #2
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="CCM" version="2.0">
|
||
<description>
|
||
CCM Authenticated Encryption Algorithm
|
||
</description>
|
||
</enumeration>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="RFPowerControl" access="readWrite" version="2.0">
|
||
<description>
|
||
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.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="Normal" version="2.0"/>
|
||
<enumeration value="Reduced" version="2.0"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="FirmwareVersion" access="readOnly" version="2.0">
|
||
<description>
|
||
Firmware version of the base as defined in {{bibref|ETSI_TS_102_527-3}}
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="20"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="EepromVersion" access="readOnly" version="2.0">
|
||
<description>
|
||
EEPROM version of the base as defined in {{bibref|ETSI_TS_102_527-3}}
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="20"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="HardwareVersion" access="readOnly" version="2.0">
|
||
<description>
|
||
Hardware version of the base as defined in {{bibref|ETSI_TS_102_527-3}}
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="20"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.DECT.Base.{i}.Stats." access="readOnly" minEntries="1" maxEntries="1" version="2.0">
|
||
<description>
|
||
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 {{param|#.Status}} parameter transitions to a down state after the base is disabled) or when the base becomes administratively up (i.e. the base's {{param|#.Enable}} parameter transitions from {{false}} to {{true}}).
|
||
</description>
|
||
<parameter name="Handovers" access="readOnly" activeNotify="canDeny" version="2.0">
|
||
<description>
|
||
The count of all successful handovers.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="HandoverFailures" access="readOnly" activeNotify="canDeny" version="2.0">
|
||
<description>
|
||
The count of all failed handovers.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="ControlFieldErrors" access="readOnly" activeNotify="canDeny" version="2.0">
|
||
<description>
|
||
The count of all bad A-field packets.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="PayloadFieldErrors" access="readOnly" activeNotify="canDeny" version="2.0">
|
||
<description>
|
||
The count of all bad B-field packets.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="SyncFailures" access="readOnly" activeNotify="canDeny" version="2.0">
|
||
<description>
|
||
The count of all synchronization failures during all calls.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.DECT.Portable.{i}." access="readOnly" numEntriesParameter="PortableNumberOfEntries" minEntries="0" maxEntries="unbounded" version="2.0">
|
||
<description>
|
||
DECT portable table.
|
||
</description>
|
||
<uniqueKey>
|
||
<parameter ref="IPEI"/>
|
||
</uniqueKey>
|
||
<uniqueKey functional="false">
|
||
<parameter ref="Alias"/>
|
||
</uniqueKey>
|
||
<parameter name="Enable" access="readWrite" version="2.0">
|
||
<description>
|
||
Enables or disables this DECT portable.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Status" access="readOnly" version="2.0">
|
||
<description>
|
||
Indicates the status of this DECT portable.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="Up" version="2.0"/>
|
||
<enumeration value="Error" version="2.0"/>
|
||
<enumeration value="Testing" version="2.0"/>
|
||
<enumeration value="Disabled" version="2.0"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Alias" access="readWrite" activeNotify="canDeny" version="2.0">
|
||
<description>
|
||
{{datatype|expand}}
|
||
</description>
|
||
<syntax>
|
||
<dataType ref="Alias"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="CodecList" access="readWrite" version="2.0">
|
||
<description>
|
||
{{list}} {{reference}}
|
||
The CPE SHOULD use the first enabled item in the list among those supported by the portable.
|
||
</description>
|
||
<syntax>
|
||
<list/>
|
||
<string>
|
||
<pathRef refType="strong" targetParent=".CodecProfile." targetType="row"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="RegistrationStatus" access="readOnly" version="2.0">
|
||
<description>
|
||
The current registration status of the DECT portable.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="In reach" version="2.0"/>
|
||
<enumeration value="Not in reach" version="2.0"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="IPUI" access="readOnly" version="2.0">
|
||
<description>
|
||
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 {{bibref|ETSI_EN_300_175-6|Section 6.2}}).
|
||
The hexbinary string is encoded exactly as it is defined in {{bibref|ETSI_EN_300_175-5|section 7.7.30}}) :
|
||
* Bits from position 0 to 3 represent the PUT (as defined in {{bibref|ETSI_EN_300_175-6|section 7.3}}).
|
||
* Bits from position 4 to {{param|IPUILength}}-1 represent the PUN.
|
||
* Unused bits after position {{param|IPUILength}}-1 are set to 0.
|
||
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)
|
||
</description>
|
||
<syntax>
|
||
<hexBinary>
|
||
<size maxLength="13"/>
|
||
</hexBinary>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="IPUILength" access="readOnly" version="2.0">
|
||
<description>
|
||
The length of {{param|IPUI}}, in {{units}}.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<units value="bits"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="IPEI" access="readOnly" version="2.0">
|
||
<description>
|
||
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 {{bibref|ETSI_EN_300_175-6|Section 10}}).
|
||
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.
|
||
</description>
|
||
<syntax>
|
||
<hexBinary>
|
||
<size maxLength="5"/>
|
||
</hexBinary>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="PARK" access="readOnly" version="2.0">
|
||
<description>
|
||
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 {{bibref|ETSI_EN_300_175-6|Sections 6.1.1 to 6.1.5}}).
|
||
The hexbinary string is encoded as follows :
|
||
* Bits from position 0 to 2 represent the ARC (as defined in {{bibref|ETSI_EN_300_175-6|section 7.2}}).
|
||
* 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.
|
||
</description>
|
||
<syntax>
|
||
<hexBinary>
|
||
<size maxLength="5"/>
|
||
</hexBinary>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="BaseAttachedTo" access="readOnly" version="2.0">
|
||
<description>
|
||
Refers to the {{object|#.Base}} where this portable part is attached to.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="256"/>
|
||
<pathRef refType="strong" targetParent=".DECT.Base." targetType="row"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="PortableType" access="readOnly" version="2.0">
|
||
<description>
|
||
{{list}} Protocols used for connection.
|
||
</description>
|
||
<syntax>
|
||
<list/>
|
||
<string>
|
||
<enumeration value="GAP" version="2.0"/>
|
||
<enumeration value="CAT-iq 1.0" version="2.0"/>
|
||
<enumeration value="CAT-iq 2.0" version="2.0"/>
|
||
<enumeration value="CAT-iq 2.1" version="2.0"/>
|
||
<enumeration value="CAT-iq 3.0" version="2.0"/>
|
||
<enumeration value="CAT-iq 4.0" version="2.0"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="SubscriptionTime" access="readOnly" version="2.0">
|
||
<description>
|
||
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.
|
||
</description>
|
||
<syntax>
|
||
<dateTime/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Control" access="readWrite" version="2.0">
|
||
<description>
|
||
This parameter MAY be used by the ACS to control the registration status of the portable.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="Unregister" version="2.0">
|
||
<description>
|
||
the CPE unregisters the portable from the base, but retains the instance in the list. This is a temporary detachment procedure.
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="Disable" version="2.0">
|
||
<description>
|
||
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.
|
||
</description>
|
||
</enumeration>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="HardwareVersion" access="readOnly" version="2.0">
|
||
<description>
|
||
Indicates the Hardware Version of a DECT portable. Corresponds to the portable HW Version identifier parameter, as defined in {{bibref|ETSI_TS_102_527-4}}.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="20"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="SoftwareVersion" access="readOnly" version="2.0">
|
||
<description>
|
||
Indicates the Software Version used by a DECT portable. Maps with the portable SW Version identifier parameter, as defined in {{bibref|ETSI_TS_102_527-4}}.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="20"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="SoftwareUpgrade" access="readOnly" version="2.0">
|
||
<description>
|
||
This parameter indicates support for SUOTA (Software Update Over The Air).
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="LastUpdateDateTime" access="readOnly" version="2.0">
|
||
<description>
|
||
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.
|
||
</description>
|
||
<syntax>
|
||
<dateTime/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="OperatorName" access="readWrite" version="2.0">
|
||
<description>
|
||
The name of the operator that will be displayed on the portable, if it supports this feature.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="32"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.SIP." access="readOnly" minEntries="1" maxEntries="1" version="2.0">
|
||
<description>
|
||
This object is dedicated to SIP as defined in {{bibref|RFC3261}}. It models SIP networks, clients, proxies and registrars.
|
||
</description>
|
||
<parameter name="NetworkNumberOfEntries" access="readOnly" version="2.0">
|
||
<description>
|
||
{{numentries}}
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="ClientNumberOfEntries" access="readOnly" version="2.0">
|
||
<description>
|
||
{{numentries}}
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="ProxyNumberOfEntries" access="readOnly" version="2.0">
|
||
<description>
|
||
{{numentries}}
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="RegistrarNumberOfEntries" access="readOnly" version="2.0">
|
||
<description>
|
||
{{numentries}}
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.SIP.Client.{i}." access="readWrite" numEntriesParameter="ClientNumberOfEntries" minEntries="0" maxEntries="unbounded" version="2.0">
|
||
<description>
|
||
SIP client table (a Client as described in {{bibref|TR-104i2|Section 4.2}}). 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 {{object|.CallControl}} is used to map network-facing to user-facing objects, the relationship between the SIP client object and its associated {{object|.CallControl.Line}} object(s) is determined by the {{param|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 ({{param|RegisterMode}} is {{enum|STATIC|RegisterMode}}), multiple lines can be associated with each SIP client.
|
||
</description>
|
||
<uniqueKey functional="false">
|
||
<parameter ref="Alias"/>
|
||
</uniqueKey>
|
||
<parameter name="Enable" access="readWrite" version="2.0">
|
||
<description>
|
||
Enable or disable this client.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
<default type="object" value="false"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="QuiescentMode" access="readWrite" version="2.0">
|
||
<description>
|
||
If {{true}}, when {{param|Enable}} is set to {{false}} in-progress sessions remain intact, but no new sessions are allowed. When all sessions are terminated, the {{object}} is disabled.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Status" access="readOnly" version="2.0">
|
||
<description>
|
||
Indicates the status of this client. Unless noted otherwise, the status values apply to both registering and non-registering clients.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="Up" version="2.0">
|
||
<description>
|
||
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)
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="Initializing" version="2.0">
|
||
<description>
|
||
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...)
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="Registering" version="2.0">
|
||
<description>
|
||
The client is in the process of registering with the network. This state applies only to clients that register
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="Deregistering" version="2.0">
|
||
<description>
|
||
The client is in the process of deregistering over the network. This state applies only to clients that register
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="Error_Misconfigured" version="2.0">
|
||
<description>
|
||
The client is enabled, but is non-operational due a configuration error
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="Error_Network" version="2.0">
|
||
<description>
|
||
A network error occurred
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="Error_Registration" version="2.0">
|
||
<description>
|
||
An error occurred during registration. This state applies only to clients that register.
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="Quiescent" version="2.0">
|
||
<description>
|
||
This state indicates that the client has been disabled and is waiting for active session(s) to terminate before transitioning to the disabled state.
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="Disabled" version="2.0">
|
||
<description>
|
||
The client is disabled
|
||
</description>
|
||
</enumeration>
|
||
</string>
|
||
<default type="object" value="Disabled"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Alias" access="readWrite" activeNotify="canDeny" version="2.0">
|
||
<description>
|
||
{{datatype|expand}}
|
||
</description>
|
||
<syntax>
|
||
<dataType ref="Alias"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Origin" access="readOnly" version="2.0">
|
||
<description>
|
||
Mechanism via which this instance was assigned. {{enum}}
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="AutoConfigured" version="2.0">
|
||
<description>
|
||
Automatically generated, for example by a ESBC that auto-creates client objects
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="Static" version="2.0">
|
||
<description>
|
||
For example, present in the factory default configuration, created by the ACS, or created by some other management entity (e.g. via a GUI).
|
||
</description>
|
||
</enumeration>
|
||
</string>
|
||
<default type="object" value="Static"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="RegisterMode" access="readWrite" version="2.0">
|
||
<description>
|
||
The registration procedures to apply. For {{param}} values other than {{enum|STATIC}}, the SIP {{object|#}} conveys its RegisterURI-to-ContactURI binding to the network using the SIP registration procedure. For the {{param}} value of {{enum|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 {{param|Origin}} is {{enum|Static|Origin}}.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="RFC3261" version="2.0">
|
||
<description>
|
||
The client registers with the network using the registration procedures defined in {{bibref|RFC3261}}
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="STATIC" version="2.0">
|
||
<description>
|
||
The client does not register with the network
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="RFC6140" version="2.0">
|
||
<description>
|
||
The client registers with the network using the registration procedures defined in {{bibref|RFC6140}}
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="TISPAN" version="2.0">
|
||
<description>
|
||
The client registers with the network using the registration procedures defined in {{bibref|3GPP_TS_24.229|section 5.1.1.2}}
|
||
</description>
|
||
</enumeration>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="AuthUserName" access="readWrite" version="2.0">
|
||
<description>
|
||
Username used to authenticate the connection to the server.
|
||
This parameter can only be modified if {{param|Origin}} is {{enum|Static|Origin}}.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="128"/>
|
||
</string>
|
||
<default type="object" value=""/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="AuthPassword" access="readWrite" version="2.0">
|
||
<description>
|
||
Password used to authenticate the connection to the server.
|
||
This parameter can only be modified if {{param|Origin}} is {{enum|Static|Origin}}.
|
||
</description>
|
||
<syntax hidden="true">
|
||
<string>
|
||
<size maxLength="128"/>
|
||
</string>
|
||
<default type="object" value=""/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Network" access="readWrite" version="2.0">
|
||
<description>
|
||
SIP network with which this SIP client is associated.
|
||
{{reference}}
|
||
This parameter can only be modified if {{param|Origin}} is {{enum|Static|Origin}}.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="256"/>
|
||
<pathRef refType="strong" targetParent=".SIP.Network." targetType="row"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="MaxSessions" access="readWrite" version="2.0">
|
||
<description>
|
||
Limit on the number of simultaneous voice sessions across this client. This MUST be less than or equal to {{param|.Capabilities.MaxSessionCount}}.
|
||
A value of zero indicates no explicit limit on the number of sessions.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
<default type="object" value="0"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="RegisterURI" access="readWrite" version="2.0">
|
||
<description>
|
||
The SIP URI that represents the identity of this SIP client. For {{param|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 {{param|Origin}} is {{enum|Static|Origin}}.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="389"/>
|
||
</string>
|
||
<default type="object" value=""/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="E164Format" access="readWrite" version="2.0">
|
||
<description>
|
||
When {{true}} and using a {{object|.Trunk}}, the SIP URIs built from the directory numbers in {{param|.Trunk.{i}.DDIRange}} SHOULD use E.164 format, using the "user=phone" URI parameter, according to {{bibref|RFC3261|section 19.1.6}}.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
<default type="object" value="true"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="T38Enable" access="readWrite" version="2.0">
|
||
<description>
|
||
Enable or disable the use of T.38.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="SIPEventSubscribeNumberOfEntries" access="readOnly" version="2.0">
|
||
<description>
|
||
{{numentries}}
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="ContactNumberOfEntries" access="readOnly" version="2.0">
|
||
<description>
|
||
{{numentries}}
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.SIP.Client.{i}.Contact.{i}." access="readWrite" numEntriesParameter="ContactNumberOfEntries" minEntries="0" maxEntries="unbounded" version="2.0">
|
||
<description>
|
||
Active registrations for this SIP account.
|
||
</description>
|
||
<uniqueKey functional="false">
|
||
<parameter ref="Alias"/>
|
||
</uniqueKey>
|
||
<parameter name="Enable" access="readWrite" version="2.0">
|
||
<description>
|
||
Enable or disable this {{object}}.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
<default type="object" value="false"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Status" access="readOnly" version="2.0">
|
||
<description>
|
||
Indicates the status of this {{object}}.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="Up" version="2.0"/>
|
||
<enumeration value="Error" version="2.0"/>
|
||
<enumeration value="Disabled" version="2.0"/>
|
||
</string>
|
||
<default type="object" value="Disabled"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Alias" access="readWrite" activeNotify="canDeny" version="2.0">
|
||
<description>
|
||
{{datatype|expand}}
|
||
</description>
|
||
<syntax>
|
||
<dataType ref="Alias"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Origin" access="readOnly" version="2.0">
|
||
<description>
|
||
Mechanism via which this {{object}} was assigned. {{enum}}
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="AutoConfigured" version="2.0">
|
||
<description>
|
||
Automatically generated, for example by a ESBC that auto-creates {{object}} objects.
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="Static" version="2.0">
|
||
<description>
|
||
For example, present in the factory default configuration, created by the ACS, or created by some other management entity (e.g. via a GUI).
|
||
</description>
|
||
</enumeration>
|
||
</string>
|
||
<default type="object" value="Static"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="IPAddress" access="readWrite" version="2.0">
|
||
<description>
|
||
This is the IP address where the {{object|#}} is listening for SIP requests from the service provider network. This IP address value is populated in the host portion of the {{param|ContactURI}} parameter.
|
||
This parameter can only be modified if {{param|Origin}} is {{enum|Static|Origin}}.
|
||
</description>
|
||
<syntax>
|
||
<dataType ref="IPAddress"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Port" access="readWrite" version="2.0">
|
||
<description>
|
||
This is the port where the {{object|#}} is listening for SIP requests from the service provider network. This IP port value is populated in the port portion of the {{param|ContactURI}} parameter.
|
||
This parameter can only be modified if {{param|Origin}} is {{enum|Static|Origin}}.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<range minInclusive="0" maxInclusive="65535"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="ContactURI" access="readWrite" version="2.0">
|
||
<description>
|
||
The current Contact URI of the {{object|#}}.
|
||
If SIP registration procedures are being used, as determined by the {{param|#.RegisterMode}} parameter, then this parameter is populated in the Contact header field of the REGISTER request.
|
||
This parameter can only be modified if {{param|Origin}} is {{enum|Static|Origin}}.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="256"/>
|
||
</string>
|
||
<default type="object" value=""/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="ExpireTime" access="readOnly" version="2.0">
|
||
<description>
|
||
Time when this registration will expire. This parameter is valid only when SIP registration procedures are being used, as determined by the {{param|#.RegisterMode}} parameter.
|
||
If this registration never expires, this parameter SHOULD be set to the Unknown Time value.
|
||
</description>
|
||
<syntax>
|
||
<dateTime/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="PingInterval" access="readWrite" version="2.0">
|
||
<description>
|
||
The interval in {{units}} 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 {{param|#.RegisterMode}} is {{enum|STATIC|#.RegisterMode}}). A value of '0' indicates that the CPE should not perform the periodic ping request.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<range minInclusive="0" maxInclusive="65535"/>
|
||
<units value="seconds"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="UserAgent" access="readOnly" version="2.0">
|
||
<description>
|
||
This is the User-Agent field reported in the SIP header of the REGISTER message.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="256"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.SIP.Client.{i}.EventSubscribe.{i}." access="readWrite" numEntriesParameter="SIPEventSubscribeNumberOfEntries" enableParameter="Enable" minEntries="0" maxEntries="unbounded" version="2.0">
|
||
<description>
|
||
Table of SIP events automatically populated by the CPE with each of the SIP event subscriptions in {{object|.SIP.Network.{i}.EventSubscribe.{i}.}}. This table allows specification of the authentication credentials needed for each event subscription.
|
||
</description>
|
||
<uniqueKey functional="false">
|
||
<parameter ref="Alias"/>
|
||
</uniqueKey>
|
||
<uniqueKey>
|
||
<parameter ref="Event"/>
|
||
</uniqueKey>
|
||
<parameter name="Enable" access="readWrite" version="2.0">
|
||
<description>
|
||
Enables or disables this entry.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
<default type="object" value="false"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Alias" access="readWrite" activeNotify="canDeny" version="2.0">
|
||
<description>
|
||
{{datatype|expand}}
|
||
</description>
|
||
<syntax>
|
||
<dataType ref="Alias"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Event" access="readOnly" version="2.0">
|
||
<description>
|
||
SIP event name corresponding to the value given in {{object|.SIP.Network.{i}.EventSubscribe.{i}.}}.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="32"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="AuthUserName" access="readWrite" version="2.0">
|
||
<description>
|
||
Username used to authenticate the connection to the event notify server.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="128"/>
|
||
</string>
|
||
<default type="object" value=""/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="AuthPassword" access="readWrite" version="2.0">
|
||
<description>
|
||
Password used to authenticate the connection to the event notify server.
|
||
</description>
|
||
<syntax hidden="true">
|
||
<string>
|
||
<size maxLength="128"/>
|
||
</string>
|
||
<default type="object" value=""/>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.SIP.Network.{i}." access="readWrite" numEntriesParameter="NetworkNumberOfEntries" minEntries="0" maxEntries="unbounded" version="2.0">
|
||
<description>
|
||
This object models a SIP network (a network as described in {{bibref|TR-104i2|Section 4.2}}). SIP networks are used by SIP {{object|#.Client}} objects so that common parameters do not have to be provisioned multiple times.
|
||
</description>
|
||
<uniqueKey functional="false">
|
||
<parameter ref="Alias"/>
|
||
</uniqueKey>
|
||
<parameter name="Enable" access="readWrite" version="2.0">
|
||
<description>
|
||
Enable or disable this {{object}}. Starts the DNS resolving when enabled.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
<default type="object" value="false"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="QuiescentMode" access="readWrite" version="2.0">
|
||
<description>
|
||
If {{true}}, when {{param|Enable}} is set to {{false}} in-progress sessions remain intact, but no new sessions are allowed. When all sessions are terminated, the {{object}} is disabled.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Status" access="readOnly" version="2.0">
|
||
<description>
|
||
Indicates the status of this network.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="Up" version="2.0"/>
|
||
<enumeration value="Resolving" version="2.0"/>
|
||
<enumeration value="Error_DNS" version="2.0"/>
|
||
<enumeration value="Error_Other" version="2.0"/>
|
||
<enumeration value="Disabled" version="2.0"/>
|
||
</string>
|
||
<default type="object" value="Disabled"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Alias" access="readWrite" activeNotify="canDeny" version="2.0">
|
||
<description>
|
||
{{datatype|expand}}
|
||
</description>
|
||
<syntax>
|
||
<dataType ref="Alias"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="ProxyServer" access="readWrite" version="2.0">
|
||
<description>
|
||
Host name or IP address of the SIP proxy server.
|
||
If not {{empty}}, all SIP signaling traffic MUST be sent to the host indicated by this parameter and the port indicated by {{param|ProxyServerPort}} unless {{param|OutboundProxy}} is not {{empty}} or a different route was discovered during normal SIP routing operations.
|
||
Regardless of which host the traffic gets sent to ({{param}} or {{param|OutboundProxy}}), the value of this parameter (unless {{empty}}) 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.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="256"/>
|
||
</string>
|
||
<default type="object" value=""/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="ProxyServerPort" access="readWrite" version="2.0">
|
||
<description>
|
||
Destination port to be used in connecting to the SIP proxy server.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<range minInclusive="0" maxInclusive="65535"/>
|
||
</unsignedInt>
|
||
<default type="object" value="5060"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="ProxyServerTransport" access="readWrite" version="2.0">
|
||
<description>
|
||
Transport protocol to be used in connecting to the SIP proxy server.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="UDP" version="2.0"/>
|
||
<enumeration value="TCP" version="2.0"/>
|
||
<enumeration value="TLS" version="2.0"/>
|
||
<enumeration value="SCTP" version="2.0"/>
|
||
</string>
|
||
<default type="object" value="UDP"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="RegistrarServer" access="readWrite" version="2.0">
|
||
<description>
|
||
Host name or IP address of the SIP registrar server.
|
||
If this parameter 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 {{param|ProxyServer}}, {{param|ProxyServerPort}}, and {{param|ProxyServerTransport}}.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="256"/>
|
||
</string>
|
||
<default type="object" value=""/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="RegistrarServerPort" access="readWrite" version="2.0">
|
||
<description>
|
||
Destination port to be used in connecting to the SIP registrar server.
|
||
If {{param|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 {{param|ProxyServer}}, {{param|ProxyServerPort}}, and {{param|ProxyServerTransport}}.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<range minInclusive="0" maxInclusive="65535"/>
|
||
</unsignedInt>
|
||
<default type="object" value="5060"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="RegistrarServerTransport" access="readWrite" version="2.0">
|
||
<description>
|
||
Transport protocol to be used in connecting to the registrar server. {{enum}}
|
||
If {{param|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 {{param|ProxyServer}}, {{param|ProxyServerPort}}, and {{param|ProxyServerTransport}}.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="UDP" version="2.0"/>
|
||
<enumeration value="TCP" version="2.0"/>
|
||
<enumeration value="TLS" version="2.0"/>
|
||
<enumeration value="SCTP" version="2.0"/>
|
||
</string>
|
||
<default type="object" value="UDP"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="ServerDomain" access="readWrite" version="2.0">
|
||
<description>
|
||
If non-empty this {{param}} is used by the devices in a DNS SRV request to provide FQDNs {{object|FQDNServer.{i}.}} for SIP Server connections.
|
||
{{bibref|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.''
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="256"/>
|
||
</string>
|
||
<default type="object" value=""/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="ChosenDomain" access="readOnly" version="2.0">
|
||
<description>
|
||
Domain used by {{object|#.Client}} objects that reference this {{object}} instance.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="256"/>
|
||
</string>
|
||
<default type="object" value=""/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="ChosenIPAddress" access="readOnly" version="2.0">
|
||
<description>
|
||
IP address used to reach the {{param|ChosenDomain}}.
|
||
</description>
|
||
<syntax>
|
||
<dataType ref="IPAddress"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="ChosenPort" access="readOnly" version="2.0">
|
||
<description>
|
||
Port used to reach the {{param|ChosenDomain}}.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<range minInclusive="0" maxInclusive="65535"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="UserAgentDomain" access="readWrite" version="2.0">
|
||
<description>
|
||
CPE domain string. If {{empty}}, the CPE SHOULD use its IP address as the domain.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="256"/>
|
||
</string>
|
||
<default type="object" value=""/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="UserAgentPort" access="readWrite" version="2.0">
|
||
<description>
|
||
Port used for incoming call control signaling.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<range minInclusive="0" maxInclusive="65535"/>
|
||
</unsignedInt>
|
||
<default type="object" value="0"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="UserAgentTransport" access="readWrite" version="2.0">
|
||
<description>
|
||
Transport protocol to be used for incoming call control signaling.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="UDP" version="2.0"/>
|
||
<enumeration value="TCP" version="2.0"/>
|
||
<enumeration value="TLS" version="2.0"/>
|
||
<enumeration value="SCTP" version="2.0"/>
|
||
</string>
|
||
<default type="object" value="UDP"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="OutboundProxy" access="readWrite" version="2.0">
|
||
<description>
|
||
The Fully Qualified Domain Name (FQDN) or IP Address of the outbound proxy. If the value is not {{empty}}, the SIP endpoint MUST send all SIP traffic (requests and responses) to the host indicated by this parameter and the port indicated by {{param|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. {{param}} is NOT used to generate the URI placed into the Route header of any requests.
|
||
When {{param}} is assigned, the name is looked up (resolved) and the corresponding address is set in {{param|OutboundProxyResolvedAddress}}.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="256"/>
|
||
</string>
|
||
<default type="object" value=""/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="OutboundProxyResolvedAddress" access="readOnly" version="2.0">
|
||
<description>
|
||
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 {{param|OutboundProxy}}) or assigned dynamically (via DHCP).
|
||
When {{param|OutboundProxy}} is assigned, the name is looked up (resolved) and the corresponding address is set in {{param}}.
|
||
</description>
|
||
<syntax>
|
||
<dataType ref="IPAddress"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="OutboundProxyPrecedence" access="readOnly" version="2.0">
|
||
<description>
|
||
Indicates whether it is the static configuration or the DHCP configuration that is actually used for {{param|OutboundProxyResolvedAddress}}.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="Static" version="2.0"/>
|
||
<enumeration value="DHCP" version="2.0"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="OutboundProxyPort" access="readWrite" version="2.0">
|
||
<description>
|
||
Destination port to be used in connecting to the outbound proxy. This parameter MUST be ignored unless the value of {{param|OutboundProxy}} is non-empty.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<range minInclusive="0" maxInclusive="65535"/>
|
||
</unsignedInt>
|
||
<default type="object" value="5060"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="STUNEnable" access="readWrite" version="2.0">
|
||
<description>
|
||
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.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
<default type="object" value="false"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="STUNServer" access="readWrite" version="2.0">
|
||
<description>
|
||
Domain name or IP address of the STUN server.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="256"/>
|
||
</string>
|
||
<default type="object" value=""/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="NonVoiceBandwidthReservedUpstream" access="readWrite" version="2.0">
|
||
<description>
|
||
For bandwidth-based admission control, a session can proceed only if there is {{param}} {{units}} 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.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<units value="bits per second"/>
|
||
</unsignedInt>
|
||
<default type="object" value="0"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="NonVoiceBandwidthReservedDownstream" access="readWrite" version="2.0">
|
||
<description>
|
||
For bandwidth-based admission control, a session can proceed only if there is {{param}} {{units}} 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.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<units value="bits per second"/>
|
||
</unsignedInt>
|
||
<default type="object" value="0"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Organization" access="readWrite" version="2.0">
|
||
<description>
|
||
Text string to be used in the Organization header.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="256"/>
|
||
</string>
|
||
<default type="object" value=""/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="RegistrationPeriod" access="readWrite" version="2.0">
|
||
<description>
|
||
Duration, in {{units}}, after which the user agent needs to register again.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<range minInclusive="1"/>
|
||
<units value="seconds"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Realm" access="readWrite" version="2.0">
|
||
<description>
|
||
Realm for authentication with the specified values of {{param|#.Client.{i}.AuthUserName}} and {{param|#.Client.{i}.AuthPassword}}.
|
||
</description>
|
||
<syntax>
|
||
<string/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="TimerT1" access="readWrite" version="2.0">
|
||
<description>
|
||
Value of SIP timer T1, in {{units}}, as defined in {{bibref|RFC3261}}.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<range minInclusive="1"/>
|
||
<units value="milliseconds"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="TimerT2" access="readWrite" version="2.0">
|
||
<description>
|
||
Value of SIP timer T2, in {{units}}, as defined in {{bibref|RFC3261}}.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<range minInclusive="1"/>
|
||
<units value="milliseconds"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="TimerT4" access="readWrite" version="2.0">
|
||
<description>
|
||
Value of SIP timer T4, in {{units}}, as defined in {{bibref|RFC3261}}.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<range minInclusive="1"/>
|
||
<units value="milliseconds"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="TimerA" access="readWrite" version="2.0">
|
||
<description>
|
||
Value of SIP timer A, in {{units}}, as defined in {{bibref|RFC3261}}.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<range minInclusive="1"/>
|
||
<units value="milliseconds"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="TimerB" access="readWrite" version="2.0">
|
||
<description>
|
||
Value of SIP timer B, in {{units}}, as defined in {{bibref|RFC3261}}.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<range minInclusive="1"/>
|
||
<units value="milliseconds"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="TimerC" access="readWrite" version="2.0">
|
||
<description>
|
||
Value of SIP timer C, in {{units}}, as defined in {{bibref|RFC3261}}.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<range minInclusive="1"/>
|
||
<units value="milliseconds"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="TimerD" access="readWrite" version="2.0">
|
||
<description>
|
||
Value of SIP timer D, in {{units}}, as defined in {{bibref|RFC3261}}.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<range minInclusive="1"/>
|
||
<units value="milliseconds"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="TimerE" access="readWrite" version="2.0">
|
||
<description>
|
||
Value of SIP timer E, in {{units}}, as defined in {{bibref|RFC3261}}.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<range minInclusive="1"/>
|
||
<units value="milliseconds"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="TimerF" access="readWrite" version="2.0">
|
||
<description>
|
||
Value of SIP timer F, in {{units}}, as defined in {{bibref|RFC3261}}.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<range minInclusive="1"/>
|
||
<units value="milliseconds"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="TimerG" access="readWrite" version="2.0">
|
||
<description>
|
||
Value of SIP timer G, in {{units}}, as defined in {{bibref|RFC3261}}.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<range minInclusive="1"/>
|
||
<units value="milliseconds"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="TimerH" access="readWrite" version="2.0">
|
||
<description>
|
||
Value of SIP timer H, in {{units}}, as defined in {{bibref|RFC3261}}.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<range minInclusive="1"/>
|
||
<units value="milliseconds"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="TimerI" access="readWrite" version="2.0">
|
||
<description>
|
||
Value of SIP timer I, in {{units}}, as defined in {{bibref|RFC3261}}.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<range minInclusive="1"/>
|
||
<units value="milliseconds"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="TimerJ" access="readWrite" version="2.0">
|
||
<description>
|
||
Value of SIP timer J, in {{units}}, as defined in {{bibref|RFC3261}}.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<range minInclusive="1"/>
|
||
<units value="milliseconds"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="TimerK" access="readWrite" version="2.0">
|
||
<description>
|
||
Value of SIP timer K, in {{units}}, as defined in {{bibref|RFC3261}}.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<range minInclusive="1"/>
|
||
<units value="milliseconds"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="InviteExpires" access="readWrite" version="2.0">
|
||
<description>
|
||
Invite request Expires header value, in {{units}}.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<range minInclusive="1"/>
|
||
<units value="seconds"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="ReInviteExpires" access="readWrite" version="2.0">
|
||
<description>
|
||
Re-invite request Expires header value, in {{units}}.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<range minInclusive="1"/>
|
||
<units value="seconds"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="RegisterExpires" access="readWrite" version="2.0">
|
||
<description>
|
||
Register request Expires header value, in {{units}}.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<range minInclusive="1"/>
|
||
<units value="seconds"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="RegisterRetryInterval" access="readWrite" version="2.0">
|
||
<description>
|
||
Register retry interval, in {{units}}.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<range minInclusive="1"/>
|
||
<units value="seconds"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="InboundAuth" access="readWrite" version="2.0">
|
||
<description>
|
||
Applicable inbound authentication method, if any.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="None" version="2.0"/>
|
||
<enumeration value="Digest" version="2.0">
|
||
<description>
|
||
when selected, {{param|InboundAuthUsername}} and {{param|InboundAuthPassword}} MUST be specified.
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="SourceFilter" version="2.0">
|
||
<description>
|
||
only accept incoming SIP requests from IP addresses associated with {{param|ProxyServer}}
|
||
</description>
|
||
</enumeration>
|
||
</string>
|
||
<default type="object" value="None"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="InboundAuthUsername" access="readWrite" version="2.0">
|
||
<description>
|
||
If inbound authentication is used, the username credentials.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="256"/>
|
||
</string>
|
||
<default type="object" value=""/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="InboundAuthPassword" access="readWrite" version="2.0">
|
||
<description>
|
||
If inbound authentication is used, the password credentials.
|
||
</description>
|
||
<syntax hidden="true">
|
||
<string>
|
||
<size maxLength="256"/>
|
||
</string>
|
||
<default type="object" value=""/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="UseCodecPriorityInSDPResponse" access="readWrite" version="2.0">
|
||
<description>
|
||
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 {{param|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.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
<default type="object" value="false"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="DSCPMark" access="readWrite" version="2.0">
|
||
<description>
|
||
Diffserv code point to be used for outgoing SIP signaling packets.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<range minInclusive="0" maxInclusive="63"/>
|
||
</unsignedInt>
|
||
<default type="object" value="0"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="VLANIDMark" access="readWrite" version="2.0">
|
||
<description>
|
||
VLAN ID (as defined in {{bibref|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 {{param}} or {{param|EthernetPriorityMark}} are greater than zero, then the outgoing frames MUST be tagged. Otherwise, the outgoing frames MAY be tagged or untagged.
|
||
</description>
|
||
<syntax>
|
||
<int>
|
||
<range minInclusive="-1"/>
|
||
</int>
|
||
<default type="object" value="-1"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="EthernetPriorityMark" access="readWrite" version="2.0">
|
||
<description>
|
||
Ethernet priority code (as defined in {{bibref|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 {{param|VLANIDMark}} or {{param}} are greater than zero, then the outgoing frames MUST be tagged. Otherwise, the outgoing frames MAY be tagged or untagged.
|
||
</description>
|
||
<syntax>
|
||
<int>
|
||
<range minInclusive="-1"/>
|
||
</int>
|
||
<default type="object" value="-1"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="ConferenceCallDomainURI" access="readWrite" version="2.0">
|
||
<description>
|
||
URI of the network conference bridge for the multiway conference call service.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="256"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="TimerLoginRejected" access="readWrite" version="2.0">
|
||
<description>
|
||
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 {{units}}). If stale=true, the CPE shall send REGISTER using credentials.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<units value="seconds"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="NoLoginRetry" access="readWrite" version="2.0">
|
||
<description>
|
||
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.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="TimerRegistrationFailed" access="readWrite" version="2.0">
|
||
<description>
|
||
In case of no response to a REGISTER request, the CPE shall retry according to retransmission algorithm defined in {{bibref|RFC3261}}, then wait for expiration of this timer (in {{units}}).
|
||
In case of other response, the CPE shall wait for expiration of this timer before sending a new REGISTER request.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<units value="seconds"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="TimerSubscriptionFailed" access="readWrite" version="2.0">
|
||
<description>
|
||
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 {{bibref|RFC3261}}, then wait for expiration of this timer (in {{units}}) before sending a new SUBSCRIBE request.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<units value="seconds"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="UnansweredRegistrationAttempts" access="readOnly" version="2.0">
|
||
<description>
|
||
The number of registration timeouts when trying to register the server.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="VoIPProfile" access="readWrite" version="2.0">
|
||
<description>
|
||
VoIP profile to use with this {{object}}.
|
||
{{reference}}
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="256"/>
|
||
<pathRef refType="strong" targetParent=".VoIPProfile." targetType="row"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="CodecList" access="readWrite" version="2.0">
|
||
<description>
|
||
{{list}} {{reference}}
|
||
The CPE SHOULD use the first enabled item in the list among those supported by the remote endpoint and consistent with the available bandwidth.
|
||
</description>
|
||
<syntax>
|
||
<list/>
|
||
<string>
|
||
<pathRef refType="strong" targetParent=".CodecProfile." targetType="row"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="MaxSessions" access="readWrite" version="2.0">
|
||
<description>
|
||
Limit on the number of simultaneous voice sessions across all {{object|.SIP.Client}} referencing this {{object}}. This MUST be less than or equal to {{param|.Capabilities.MaxSessionCount}}.
|
||
A value of zero indicates no explicit limit on the number of sessions.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
<default type="object" value="0"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="FQDNServerNumberOfEntries" access="readOnly" version="2.0">
|
||
<description>
|
||
{{numentries}}
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="EventSubscribeNumberOfEntries" access="readOnly" version="2.0">
|
||
<description>
|
||
{{numentries}}
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="ResponseMapNumberOfEntries" access="readOnly" version="2.0">
|
||
<description>
|
||
{{numentries}}
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<range minInclusive="0" maxInclusive="999"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.SIP.Network.{i}.FQDNServer.{i}." access="readWrite" numEntriesParameter="FQDNServerNumberOfEntries" enableParameter="Enable" minEntries="0" maxEntries="unbounded" version="2.0">
|
||
<description>
|
||
Table of Fully Qualified Domain Names for this {{object|#}} instance in order to connect to the SIP server as described in {{bibref|RFC2782}}.
|
||
</description>
|
||
<uniqueKey functional="false">
|
||
<parameter ref="Alias"/>
|
||
</uniqueKey>
|
||
<uniqueKey>
|
||
<parameter ref="Domain"/>
|
||
</uniqueKey>
|
||
<parameter name="Enable" access="readWrite" version="2.0">
|
||
<description>
|
||
Enables or disables this FQDN server.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
<default type="object" value="false"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Alias" access="readWrite" activeNotify="canDeny" version="2.0">
|
||
<description>
|
||
{{datatype|expand}}
|
||
</description>
|
||
<syntax>
|
||
<dataType ref="Alias"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Origin" access="readOnly" version="2.0">
|
||
<description>
|
||
Mechanism via which the FQDN server was assigned.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="AutoConfigured" version="2.0">
|
||
<description>
|
||
Automatically generated, for example by a CPE that utilizes DNS SRV record requests
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="Static" version="2.0">
|
||
<description>
|
||
For example, present in the factory default configuration, created by the ACS, or created by some other management entity (e.g. via a GUI)
|
||
</description>
|
||
</enumeration>
|
||
</string>
|
||
<default type="object" value="Static"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Domain" access="readWrite" version="2.0">
|
||
<description>
|
||
The domain name of the target host. This parameter can only be modified if {{param|Origin}} is {{enum|Static|Origin}}.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="256"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Weight" access="readWrite" version="2.0">
|
||
<description>
|
||
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 {{param|Origin}} is {{enum|Static|Origin}}.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<range minInclusive="0" maxInclusive="65535"/>
|
||
</unsignedInt>
|
||
<default type="object" value="0"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Priority" access="readWrite" version="2.0">
|
||
<description>
|
||
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 {{param|Origin}} is {{enum|Static|Origin}}.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<range minInclusive="0" maxInclusive="65535"/>
|
||
</unsignedInt>
|
||
<default type="object" value="0"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Port" access="readWrite" version="2.0">
|
||
<description>
|
||
The port on this target host of this service.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<range minInclusive="0" maxInclusive="65535"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="IPAddresses" access="readWrite" version="2.0">
|
||
<description>
|
||
{{list|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 {{param|Origin}} is {{enum|Static|Origin}}.
|
||
</description>
|
||
<syntax>
|
||
<list/>
|
||
<dataType ref="IPAddress"/>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.SIP.Network.{i}.EventSubscribe.{i}." access="readWrite" numEntriesParameter="EventSubscribeNumberOfEntries" enableParameter="Enable" minEntries="0" maxEntries="unbounded" version="2.0">
|
||
<description>
|
||
Table to specify the SIP events to which the CPE MUST subscribe.
|
||
</description>
|
||
<uniqueKey functional="false">
|
||
<parameter ref="Alias"/>
|
||
</uniqueKey>
|
||
<uniqueKey>
|
||
<parameter ref="Event"/>
|
||
</uniqueKey>
|
||
<parameter name="Enable" access="readWrite" version="2.0">
|
||
<description>
|
||
Enables or disables this entry.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
<default type="object" value="false"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Alias" access="readWrite" activeNotify="canDeny" version="2.0">
|
||
<description>
|
||
{{datatype|expand}}
|
||
</description>
|
||
<syntax>
|
||
<dataType ref="Alias"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Event" access="readWrite" version="2.0">
|
||
<description>
|
||
SIP event name to appear in the EVENT header of the SIP SUBSCRIBE request.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="32"/>
|
||
</string>
|
||
<default type="object" value=""/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Notifier" access="readWrite" version="2.0">
|
||
<description>
|
||
Host name or IP address of the event notify server.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="256"/>
|
||
</string>
|
||
<default type="object" value=""/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="NotifierPort" access="readWrite" version="2.0">
|
||
<description>
|
||
Destination port to be used in connecting to the event notifier.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<range minInclusive="0" maxInclusive="65535"/>
|
||
</unsignedInt>
|
||
<default type="object" value="0"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="NotifierTransport" access="readWrite" version="2.0">
|
||
<description>
|
||
Transport protocol to be used in connecting to the event notifier.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="UDP" version="2.0"/>
|
||
<enumeration value="TCP" version="2.0"/>
|
||
<enumeration value="TLS" version="2.0"/>
|
||
<enumeration value="SCTP" version="2.0"/>
|
||
</string>
|
||
<default type="object" value="UDP"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="ExpireTime" access="readWrite" version="2.0">
|
||
<description>
|
||
Subscription refresh timer, in {{units}}.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<units value="seconds"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.SIP.Network.{i}.ResponseMap.{i}." access="readWrite" numEntriesParameter="ResponseMapNumberOfEntries" enableParameter="Enable" minEntries="0" maxEntries="unbounded" version="2.0">
|
||
<description>
|
||
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).
|
||
</description>
|
||
<uniqueKey functional="false">
|
||
<parameter ref="Alias"/>
|
||
</uniqueKey>
|
||
<uniqueKey>
|
||
<parameter ref="SIPResponseNumber"/>
|
||
</uniqueKey>
|
||
<parameter name="Alias" access="readWrite" activeNotify="canDeny" version="2.0">
|
||
<description>
|
||
{{datatype|expand}}
|
||
</description>
|
||
<syntax>
|
||
<dataType ref="Alias"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="SIPResponseNumber" access="readWrite" version="2.0">
|
||
<description>
|
||
The SIP response code number.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<range minInclusive="101" maxInclusive="999"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Enable" access="readWrite" version="2.0">
|
||
<description>
|
||
Enables or disables this entry.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
<default type="object" value="false"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="TextMessage" access="readWrite" version="2.0">
|
||
<description>
|
||
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 {{empty}}, display of this text preempts the value of {{param|.Tone.Description.{i}.ToneText}} associated with {{param|Tone}}. If this parameter is {{empty}}, the value of {{param|.Tone.Description.{i}.ToneText}} associated with {{param|Tone}}, if any, is displayed instead.
|
||
This parameter is applicable only for VoIP devices capable of text display.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="64"/>
|
||
</string>
|
||
<default type="object" value=""/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Tone" access="readWrite" version="2.0">
|
||
<description>
|
||
The tone to be played to the user when the SIP response is received.
|
||
{{reference}}
|
||
{{empty}} indicates no tone is to be played for this event.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="256"/>
|
||
<pathRef refType="strong" targetParent=".Tone.Description." targetType="row"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.SIP.Proxy.{i}." access="readWrite" numEntriesParameter="ProxyNumberOfEntries" enableParameter="Enable" minEntries="0" maxEntries="unbounded" version="2.0">
|
||
<description>
|
||
Global SIP parameters used by the CPE when acting as proxy for SIP user agents.
|
||
</description>
|
||
<uniqueKey functional="false">
|
||
<parameter ref="Alias"/>
|
||
</uniqueKey>
|
||
<uniqueKey>
|
||
<parameter ref="ProxyIPAddress"/>
|
||
<parameter ref="ProxyPort"/>
|
||
</uniqueKey>
|
||
<parameter name="Enable" access="readWrite" version="2.0">
|
||
<description>
|
||
Enable or disable the proxy.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
<default type="object" value="false"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Status" access="readOnly" version="2.0">
|
||
<description>
|
||
Indicates the status of this proxy.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="Up" version="2.0"/>
|
||
<enumeration value="Error" version="2.0"/>
|
||
<enumeration value="Disabled" version="2.0"/>
|
||
</string>
|
||
<default type="object" value="Disabled"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Alias" access="readWrite" activeNotify="canDeny" version="2.0">
|
||
<description>
|
||
{{datatype|expand}}
|
||
</description>
|
||
<syntax>
|
||
<dataType ref="Alias"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Origin" access="readOnly" version="2.0">
|
||
<description>
|
||
Mechanism via which the IP address was assigned. {{enum}}
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="AutoConfigured" version="2.0">
|
||
<description>
|
||
Automatically generated, for example by a ESBC that auto-creates {{object}} objects
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="Static" version="2.0">
|
||
<description>
|
||
For example, present in the factory default configuration, created by the ACS, or created by some other management entity (e.g. via a GUI).
|
||
</description>
|
||
</enumeration>
|
||
</string>
|
||
<default type="object" value="Static"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="ProxyIPAddress" access="readWrite" version="2.0">
|
||
<description>
|
||
The IP address the proxy listens on.
|
||
This parameter can only be modified if {{param|Origin}} is {{enum|Static|Origin}}.
|
||
</description>
|
||
<syntax>
|
||
<dataType ref="IPAddress"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="ProxyPort" access="readWrite" version="2.0">
|
||
<description>
|
||
The port the proxy listens on.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<range minInclusive="0" maxInclusive="65535"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="ContactURI" access="readOnly" version="2.0">
|
||
<description>
|
||
Built by the CPE using {{param|ProxyIPAddress}} and {{param|ProxyPort}}.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="256"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="VoIPProfile" access="readWrite" version="2.0">
|
||
<description>
|
||
VoIP profile to use with this proxy.
|
||
{{reference}}
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="256"/>
|
||
<pathRef refType="strong" targetParent=".VoIPProfile." targetType="row"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.SIP.Registrar.{i}." access="readWrite" numEntriesParameter="RegistrarNumberOfEntries" enableParameter="Enable" minEntries="0" maxEntries="unbounded" version="2.0">
|
||
<description>
|
||
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).
|
||
</description>
|
||
<uniqueKey functional="false">
|
||
<parameter ref="Alias"/>
|
||
</uniqueKey>
|
||
<uniqueKey>
|
||
<parameter ref="RegistrarPort"/>
|
||
<parameter ref="RegistrarIPAddress"/>
|
||
</uniqueKey>
|
||
<parameter name="Enable" access="readWrite" version="2.0">
|
||
<description>
|
||
Enable or disable the registrar.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
<default type="object" value="false"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="QuiescentMode" access="readWrite" version="2.0">
|
||
<description>
|
||
If {{true}}, when {{param|Enable}} is set to {{false}} in-progress sessions remain intact, but no new sessions are allowed. When all sessions are terminated, the {{object}} is disabled.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Status" access="readOnly" version="2.0">
|
||
<description>
|
||
Indicates the status of this registrar.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="Up" version="2.0"/>
|
||
<enumeration value="Error" version="2.0"/>
|
||
<enumeration value="Disabled" version="2.0"/>
|
||
</string>
|
||
<default type="object" value="Disabled"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Alias" access="readWrite" activeNotify="canDeny" version="2.0">
|
||
<description>
|
||
{{datatype|expand}}
|
||
</description>
|
||
<syntax>
|
||
<dataType ref="Alias"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Origin" access="readOnly" version="2.0">
|
||
<description>
|
||
Mechanism via which the IP address was assigned. {{enum}}
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="AutoConfigured" version="2.0">
|
||
<description>
|
||
Automatically generated, for example by a ESBC that auto-creates {{object}} objects
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="Static" version="2.0">
|
||
<description>
|
||
For example, present in the factory default configuration, created by the ACS, or created by some other management entity (e.g. via a GUI)
|
||
</description>
|
||
</enumeration>
|
||
</string>
|
||
<default type="object" value="Static"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="RegistrarIPAddress" access="readWrite" version="2.0">
|
||
<description>
|
||
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 {{param|Origin}} is {{enum|Static|Origin}}.
|
||
</description>
|
||
<syntax>
|
||
<dataType ref="IPAddress"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="RegistrarPort" access="readWrite" version="2.0">
|
||
<description>
|
||
The port the registrar listens on.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<range minInclusive="0" maxInclusive="65535"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="RegisterExpires" access="readWrite" version="2.0">
|
||
<description>
|
||
The minimum register expire time in {{units}}. This parameter is valid only for SIP user agents that support registration.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<units value="seconds"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="PingInterval" access="readWrite" version="2.0">
|
||
<description>
|
||
The interval in {{units}} 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.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<range minInclusive="0" maxInclusive="65535"/>
|
||
<units value="seconds"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Organization" access="readWrite" version="2.0">
|
||
<description>
|
||
Text string to be used in the Organization header.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="256"/>
|
||
</string>
|
||
<default type="object" value=""/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Realm" access="readWrite" version="2.0">
|
||
<description>
|
||
Realm for authentication with the specified values of {{param|Account.{i}.AuthUserName}} and {{param|Account.{i}.AuthPassword}}.
|
||
</description>
|
||
<syntax>
|
||
<string/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="VoIPProfile" access="readWrite" version="2.0">
|
||
<description>
|
||
VoIP profile to use with this registrar.
|
||
{{reference}}
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="256"/>
|
||
<pathRef refType="strong" targetParent=".VoIPProfile." targetType="row"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="ContactURI" access="readOnly" version="2.0">
|
||
<description>
|
||
Built by the CPE using {{param|RegistrarIPAddress}} and {{param|RegistrarPort}}.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="256"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="AccountNumberOfEntries" access="readOnly" version="2.0">
|
||
<description>
|
||
{{numentries}}
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.SIP.Registrar.{i}.Account.{i}." access="readWrite" numEntriesParameter="AccountNumberOfEntries" enableParameter="Enable" minEntries="0" maxEntries="unbounded" version="2.0">
|
||
<description>
|
||
SIP account table.
|
||
</description>
|
||
<uniqueKey>
|
||
<parameter ref="URI"/>
|
||
</uniqueKey>
|
||
<uniqueKey functional="false">
|
||
<parameter ref="Alias"/>
|
||
</uniqueKey>
|
||
<parameter name="Enable" access="readWrite" version="2.0">
|
||
<description>
|
||
Enables or disables this account, or places it into a quiescent state. {{enum}}
|
||
In the {{enum|Quiescent}} state, in-progress sessions remain intact, but no new sessions are allowed. If this parameter is set to {{enum|Quiescent}} in a CPE that does not support the {{enum|Quiescent}} state, it MUST treat it the same as the {{enum|Disable}} state (and indicate {{enum|Disabled|Status}} in {{param|Status}}).
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="Enable" version="2.0"/>
|
||
<enumeration value="Quiescent" optional="true" version="2.0"/>
|
||
<enumeration value="Disable" version="2.0"/>
|
||
</string>
|
||
<default type="object" value="Disable"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="QuiescentMode" access="readWrite" version="2.0">
|
||
<description>
|
||
If {{true}}, when {{param|Enable}} is set to {{false}} in-progress sessions remain intact, but no new sessions are allowed. When all sessions are terminated, the {{object}} is disabled.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Status" access="readOnly" version="2.0">
|
||
<description>
|
||
Indicates the status of this account. Unless noted otherwise, the {{param}} values apply to both registering and non-registering external SIP user agents.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="Up" version="2.0">
|
||
<description>
|
||
The {{object}} 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
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="Initializing" version="2.0">
|
||
<description>
|
||
Transitional state where the {{object}} 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...)
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="Registering" version="2.0">
|
||
<description>
|
||
The external SIP user agent is in the process of registering with the CPE. This state applies only to SIP user agents that register
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="Deregistering" version="2.0">
|
||
<description>
|
||
The external SIP user agent is in the process of deregistering with the CPE. This state applies only to SIP user agents that register
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="ErrorMisconfigured" version="2.0">
|
||
<description>
|
||
The {{object}} is enabled, but is non-operational due a configuration error
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="ErrorNetwork" version="2.0">
|
||
<description>
|
||
A network error occurred
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="ErrorRegistration" version="2.0">
|
||
<description>
|
||
An error occurred during registration. This state applies only to Accounts serving SIP user agents that register
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="Quiescent" version="2.0">
|
||
<description>
|
||
This state indicates that the {{object}} has been disabled and is waiting for active session(s) to terminate before transitioning to the disabled state
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="Disabled" version="2.0">
|
||
<description>
|
||
The {{object}} is disabled
|
||
</description>
|
||
</enumeration>
|
||
</string>
|
||
<default type="object" value="Disabled"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Alias" access="readWrite" activeNotify="canDeny" version="2.0">
|
||
<description>
|
||
{{datatype|expand}}
|
||
</description>
|
||
<syntax>
|
||
<dataType ref="Alias"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Origin" access="readOnly" version="2.0">
|
||
<description>
|
||
Mechanism via which the {{object}} was created. {{enum}}
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="AutoConfigured" version="2.0">
|
||
<description>
|
||
Automatically generated, for example by a ESBC that auto-creates {{object}} objects
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="Static" version="2.0">
|
||
<description>
|
||
For example, present in the factory default configuration, created by the ACS, or created by some other management entity (e.g. via a GUI)
|
||
</description>
|
||
</enumeration>
|
||
</string>
|
||
<default type="object" value="Static"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="CallStatus" access="readOnly" version="2.0">
|
||
<description>
|
||
Indicates the call status for this account.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="Idle" version="2.0"/>
|
||
<enumeration value="Dialing" version="2.0"/>
|
||
<enumeration value="Delivered" version="2.0"/>
|
||
<enumeration value="Connected" version="2.0"/>
|
||
<enumeration value="Alerting" version="2.0"/>
|
||
<enumeration value="Disconnected" version="2.0"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="AuthUserName" access="readWrite" version="2.0">
|
||
<description>
|
||
Username used to authenticate the connection to the registrar server.
|
||
This parameter can only be modified if {{param|Origin}} is Static.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="128"/>
|
||
</string>
|
||
<default type="object" value=""/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="AuthPassword" access="readWrite" version="2.0">
|
||
<description>
|
||
Password used to authenticate the connection to the registrar server.
|
||
This parameter can only be modified if {{param|Origin}} is Static.
|
||
</description>
|
||
<syntax hidden="true">
|
||
<string>
|
||
<size maxLength="128"/>
|
||
</string>
|
||
<default type="object" value=""/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="RegistrationStatus" access="readOnly" version="2.0">
|
||
<description>
|
||
The current registration status of the externally connected SIP user agent. This parameter is valid only for SIP user agents that support registration.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="Registered" version="2.0"/>
|
||
<enumeration value="Unregistered" version="2.0"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="URI" access="readWrite" version="2.0">
|
||
<description>
|
||
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 {{param|Origin}} is {{enum|Static|Origin}}.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="389"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Domain" access="readWrite" version="2.0">
|
||
<description>
|
||
The domain name used when the SIP user agent has registered itself.
|
||
This parameter can only be modified if {{param|Origin}} is {{enum|Static|Origin}}.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="256"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="CodecList" access="readWrite" version="2.0">
|
||
<description>
|
||
{{list}} {{reference}}
|
||
The CPE SHOULD use the first enabled item in the list among those supported by the remote endpoint and consistent with the available bandwidth.
|
||
</description>
|
||
<syntax>
|
||
<list/>
|
||
<string>
|
||
<pathRef refType="strong" targetParent=".CodecProfile." targetType="row"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="VoIPProfile" access="readWrite" version="2.0">
|
||
<description>
|
||
Voice profile to use with this {{object}}.
|
||
{{reference}}
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="256"/>
|
||
<pathRef refType="strong" targetParent=".VoIPProfile." targetType="row"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="ContactNumberOfEntries" access="readOnly" version="2.0">
|
||
<description>
|
||
{{numentries}}
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.SIP.Registrar.{i}.Account.{i}.Contact.{i}." access="readWrite" numEntriesParameter="ContactNumberOfEntries" minEntries="0" maxEntries="unbounded" version="2.0">
|
||
<description>
|
||
Active registrations for this SIP account.
|
||
</description>
|
||
<uniqueKey functional="false">
|
||
<parameter ref="Alias"/>
|
||
</uniqueKey>
|
||
<parameter name="Enable" access="readWrite" version="2.0">
|
||
<description>
|
||
Enable or disable this entry.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
<default type="object" value="false"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Status" access="readOnly" version="2.0">
|
||
<description>
|
||
Indicates the status of this entry.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="Up" version="2.0"/>
|
||
<enumeration value="Error" version="2.0"/>
|
||
<enumeration value="Disabled" version="2.0"/>
|
||
</string>
|
||
<default type="object" value="Disabled"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Alias" access="readWrite" activeNotify="canDeny" version="2.0">
|
||
<description>
|
||
{{datatype|expand}}
|
||
</description>
|
||
<syntax>
|
||
<dataType ref="Alias"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Origin" access="readOnly" version="2.0">
|
||
<description>
|
||
Mechanism via which the {{object}} was assigned. {{enum}}
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="AutoConfigured" version="2.0">
|
||
<description>
|
||
Automatically generated, for example by a ESBC that auto-creates {{object}} objects.
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="Static" version="2.0">
|
||
<description>
|
||
For example, present in the factory default configuration, created by the ACS, or created by some other management entity (e.g. via a GUI).
|
||
</description>
|
||
</enumeration>
|
||
</string>
|
||
<default type="object" value="Static"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="IPAddress" access="readWrite" version="2.0">
|
||
<description>
|
||
IP Address of the externally connected SIP user agent. This is the IP address contained in the {{param|ContactURI}} parameter.
|
||
This parameter can only be modified if {{param|Origin}} is {{enum|Static|Origin}}.
|
||
</description>
|
||
<syntax>
|
||
<dataType ref="IPAddress"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Port" access="readWrite" version="2.0">
|
||
<description>
|
||
The port of the externally connected SIP user agent. This is the port contained in the {{param|ContactURI}} parameter.
|
||
This parameter can only be modified if {{param|Origin}} is {{enum|Static|Origin}}.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<range minInclusive="0" maxInclusive="65535"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="ContactURI" access="readWrite" version="2.0">
|
||
<description>
|
||
This is the SIP signaling address of the externally connected SIP user agent. If the SIP user agent registers, then {{param}} 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 {{param}} is provisioned by the ACS.
|
||
This parameter can only be modified if {{param|Origin}} is {{enum|Static|Origin}}.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="256"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="ExpireTime" access="readOnly" version="2.0">
|
||
<description>
|
||
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.
|
||
</description>
|
||
<syntax>
|
||
<dateTime/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="UserAgent" access="readWrite" version="2.0">
|
||
<description>
|
||
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.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="64"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.MGCP." access="readOnly" minEntries="1" maxEntries="1" version="2.0">
|
||
<description>
|
||
This object is dedicated to MGCP as defined in {{bibref|RFC3435}}. It models MGCP clients and networks.
|
||
</description>
|
||
<parameter name="ClientNumberOfEntries" access="readOnly" version="2.0">
|
||
<description>
|
||
{{numentries}}
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="NetworkNumberOfEntries" access="readOnly" version="2.0">
|
||
<description>
|
||
{{numentries}}
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.MGCP.Client.{i}." access="readWrite" numEntriesParameter="ClientNumberOfEntries" minEntries="0" maxEntries="unbounded" version="2.0">
|
||
<description>
|
||
MGCP client table (a client as described in {{bibref|TR-104i2|Section 4.2}}). Each MGCP client maintains a registration for the MGCP identities of the associated line with the {{object|#.Network}}.
|
||
</description>
|
||
<uniqueKey functional="false">
|
||
<parameter ref="Alias"/>
|
||
</uniqueKey>
|
||
<parameter name="Enable" access="readWrite" version="2.0">
|
||
<description>
|
||
Enable or disable this client.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
<default type="object" value="false"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="QuiescentMode" access="readWrite" version="2.0">
|
||
<description>
|
||
If {{true}}, when {{param|Enable}} is set to {{false}} in-progress sessions remain intact, but no new sessions are allowed. When all sessions are terminated, the {{object}} is disabled.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Status" access="readOnly" version="2.0">
|
||
<description>
|
||
Indicates the status of this client.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="Up" version="2.0">
|
||
<description>
|
||
The client is operational and has established connectivity with the network
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="Initializing" version="2.0">
|
||
<description>
|
||
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...)
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="Registering" version="2.0">
|
||
<description>
|
||
The client is in the process of registering with the network
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="Deregistering" version="2.0">
|
||
<description>
|
||
The client is in the process of deregistering over the network
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="Error_Misconfigured" version="2.0">
|
||
<description>
|
||
The client is enabled, but is non-operational due a configuration error
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="Error_Network" version="2.0">
|
||
<description>
|
||
A network error occurred
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="Error_Registration" version="2.0">
|
||
<description>
|
||
An error occurred during registration
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="Quiescent" version="2.0">
|
||
<description>
|
||
This state indicates that the client has been disabled and is waiting for active session(s) to terminate before transitioning to the disabled state
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="Disabled" version="2.0">
|
||
<description>
|
||
The client is disabled
|
||
</description>
|
||
</enumeration>
|
||
</string>
|
||
<default type="object" value="Disabled"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Alias" access="readWrite" activeNotify="canDeny" version="2.0">
|
||
<description>
|
||
{{datatype|expand}}
|
||
</description>
|
||
<syntax>
|
||
<dataType ref="Alias"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="RegisterMode" access="readWrite" version="2.0">
|
||
<description>
|
||
Register mode.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="Wildcard" version="2.0"/>
|
||
<enumeration value="Individual" version="2.0"/>
|
||
</string>
|
||
<default type="object" value="Wildcard"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="LocalPort" access="readWrite" version="2.0">
|
||
<description>
|
||
Port listening for incoming call control signaling.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<range minInclusive="0" maxInclusive="65535"/>
|
||
</unsignedInt>
|
||
<default type="object" value="0"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Domain" access="readWrite" version="2.0">
|
||
<description>
|
||
CPE domain string. If {{empty}}, the CPE SHOULD use its IP address.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="256"/>
|
||
</string>
|
||
<default type="object" value=""/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="User" access="readWrite" version="2.0">
|
||
<description>
|
||
User string used in accessing the call agent.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="64"/>
|
||
</string>
|
||
<default type="object" value=""/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Network" access="readWrite" version="2.0">
|
||
<description>
|
||
MGCP network with which this MGCP client is associated.
|
||
{{reference}}
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="256"/>
|
||
<pathRef refType="strong" targetParent=".MGCP.Network." targetType="row"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="MaxSessions" access="readWrite" version="2.0">
|
||
<description>
|
||
Limit on the number of simultaneous voice sessions across this {{object}}. This MUST be less than or equal to {{param|.Capabilities.MaxSessionCount}}.
|
||
A value of zero indicates no explicit limit on the number of sessions.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
<default type="object" value="0"/>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.MGCP.Network.{i}." access="readWrite" numEntriesParameter="NetworkNumberOfEntries" minEntries="0" maxEntries="unbounded" version="2.0">
|
||
<description>
|
||
This object models a MGCP network (a network as described in {{bibref|TR-104i2|Section 4.2}}).
|
||
</description>
|
||
<uniqueKey functional="false">
|
||
<parameter ref="Alias"/>
|
||
</uniqueKey>
|
||
<parameter name="Enable" access="readWrite" version="2.0">
|
||
<description>
|
||
Enable or disable the {{object}}. Starts the DNS resolving when enabled.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
<default type="object" value="false"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="QuiescentMode" access="readWrite" version="2.0">
|
||
<description>
|
||
If {{true}}, when {{param|Enable}} is set to {{false}} in-progress sessions remain intact, but no new sessions are allowed. When all sessions are terminated, the {{object}} is disabled.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Status" access="readOnly" version="2.0">
|
||
<description>
|
||
Indicates the status of this {{object}}.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="Up" version="2.0"/>
|
||
<enumeration value="Resolving" version="2.0"/>
|
||
<enumeration value="Error_DNS" version="2.0"/>
|
||
<enumeration value="Error_Other" version="2.0"/>
|
||
<enumeration value="Disabled" version="2.0"/>
|
||
</string>
|
||
<default type="object" value="Disabled"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Alias" access="readWrite" activeNotify="canDeny" version="2.0">
|
||
<description>
|
||
{{datatype|expand}}
|
||
</description>
|
||
<syntax>
|
||
<dataType ref="Alias"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="CallAgent1" access="readWrite" version="2.0">
|
||
<description>
|
||
Host name or IP address of the main MGCP call agent.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="256"/>
|
||
</string>
|
||
<default type="object" value=""/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="CallAgentPort1" access="readWrite" version="2.0">
|
||
<description>
|
||
Destination port to be used in connecting with the main MGCP call agent.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<range minInclusive="0" maxInclusive="65535"/>
|
||
</unsignedInt>
|
||
<default type="object" value="0"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="CallAgent2" access="readWrite" version="2.0">
|
||
<description>
|
||
Host name or IP address of the backup MGCP call agent.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="256"/>
|
||
</string>
|
||
<default type="object" value=""/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="CallAgentPort2" access="readWrite" version="2.0">
|
||
<description>
|
||
Destination port to be used in connecting with the backup MGCP call agent.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<range minInclusive="0" maxInclusive="65535"/>
|
||
</unsignedInt>
|
||
<default type="object" value="0"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="RetranIntervalTimer" access="readWrite" version="2.0">
|
||
<description>
|
||
Message retransfer interval, in {{units}}.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<range minInclusive="0" maxInclusive="65535"/>
|
||
<units value="seconds"/>
|
||
</unsignedInt>
|
||
<default type="object" value="1"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="MaxRetranCount" access="readWrite" version="2.0">
|
||
<description>
|
||
Max number of message retransfers.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<range minInclusive="0" maxInclusive="65535"/>
|
||
</unsignedInt>
|
||
<default type="object" value="10"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="DSCPMark" access="readWrite" version="2.0">
|
||
<description>
|
||
Diffserv code point to be used for outgoing MGCP signaling packets.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<range minInclusive="0" maxInclusive="63"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="VLANIDMark" access="readWrite" version="2.0">
|
||
<description>
|
||
VLAN ID (as defined in {{bibref|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 {{param}} or {{param|EthernetPriorityMark}} are greater than zero, then the outgoing frames MUST be tagged. Otherwise, the outgoing frames MAY be tagged or untagged.
|
||
</description>
|
||
<syntax>
|
||
<int>
|
||
<range minInclusive="-1"/>
|
||
</int>
|
||
<default type="object" value="-1"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="EthernetPriorityMark" access="readWrite" version="2.0">
|
||
<description>
|
||
Ethernet priority code (as defined in {{bibref|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 {{param|VLANIDMark}} or {{param}} are greater than zero, then the outgoing frames MUST be tagged. Otherwise, the outgoing frames MAY be tagged or untagged.
|
||
</description>
|
||
<syntax>
|
||
<int>
|
||
<range minInclusive="-1"/>
|
||
</int>
|
||
<default type="object" value="-1"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="AllowPiggybackEvents" access="readWrite" version="2.0">
|
||
<description>
|
||
Indicates whether or not piggyback events are allowed to the MGCP call agent.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="SendRSIPImmediately" access="readWrite" version="2.0">
|
||
<description>
|
||
Indicates whether or not to send RSIP immediately on restart.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="STUNEnable" access="readWrite" version="2.0">
|
||
<description>
|
||
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.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
<default type="object" value="false"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="STUNServer" access="readWrite" version="2.0">
|
||
<description>
|
||
Domain name or IP address of the STUN server.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="256"/>
|
||
</string>
|
||
<default type="object" value=""/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="NonVoiceBandwidthReservedUpstream" access="readWrite" version="2.0">
|
||
<description>
|
||
For bandwidth-based admission control, a session can proceed only if there is {{param}} {{units}} 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.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<units value="bits per second"/>
|
||
</unsignedInt>
|
||
<default type="object" value="0"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="NonVoiceBandwidthReservedDownstream" access="readWrite" version="2.0">
|
||
<description>
|
||
For bandwidth-based admission control, a session can proceed only if there is {{param}} {{units}} 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.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<units value="bits per second"/>
|
||
</unsignedInt>
|
||
<default type="object" value="0"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="MaxSessions" access="readWrite" version="2.0">
|
||
<description>
|
||
Limit on the number of simultaneous voice sessions across all {{object|.MGCP.Client.}} referencing this {{object}}. This MUST be less than or equal to {{param|.Capabilities.MaxSessionCount}}.
|
||
A value of zero indicates no explicit limit on the number of sessions.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
<default type="object" value="0"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="VoIPProfile" access="readWrite" version="2.0">
|
||
<description>
|
||
VoIP profile to use with this network.
|
||
{{reference}}
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="256"/>
|
||
<pathRef refType="strong" targetParent=".VoIPProfile." targetType="row"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="CodecList" access="readWrite" version="2.0">
|
||
<description>
|
||
{{list}} {{reference}}
|
||
The CPE SHOULD use the first enabled item in the list among those supported by the remote endpoint and consistent with the available bandwidth.
|
||
</description>
|
||
<syntax>
|
||
<list/>
|
||
<string>
|
||
<pathRef refType="strong" targetParent=".CodecProfile." targetType="row"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.H323." access="readOnly" minEntries="1" maxEntries="1" version="2.0">
|
||
<description>
|
||
This object is dedicated to H.323 as defined in {{bibref|H.323}}. It models H.323 clients and networks.
|
||
</description>
|
||
<parameter name="ClientNumberOfEntries" access="readOnly" version="2.0">
|
||
<description>
|
||
{{numentries}}
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="NetworkNumberOfEntries" access="readOnly" version="2.0">
|
||
<description>
|
||
{{numentries}}
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.H323.Client.{i}." access="readWrite" numEntriesParameter="ClientNumberOfEntries" minEntries="0" maxEntries="unbounded" version="2.0">
|
||
<description>
|
||
H.323 client table (a client as described in {{bibref|TR-104i2|Section 4.2}}). Each H.323 client maintains a registration for the H.323 identities of the associated line with the {{object|#.Network}}.
|
||
</description>
|
||
<uniqueKey functional="false">
|
||
<parameter ref="Alias"/>
|
||
</uniqueKey>
|
||
<parameter name="Enable" access="readWrite" version="2.0">
|
||
<description>
|
||
Enable or disable this client.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
<default type="object" value="false"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="QuiescentMode" access="readWrite" version="2.0">
|
||
<description>
|
||
If {{true}}, when {{param|Enable}} is set to {{false}} in-progress sessions remain intact, but no new sessions are allowed. When all sessions are terminated, the {{object}} is disabled.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Status" access="readOnly" version="2.0">
|
||
<description>
|
||
Indicates the status of this client.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="Up" version="2.0">
|
||
<description>
|
||
The client is operational and has established connectivity with the network
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="Initializing" version="2.0">
|
||
<description>
|
||
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...)
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="Registering" version="2.0">
|
||
<description>
|
||
The client is in the process of registering with the network
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="Deregistering" version="2.0">
|
||
<description>
|
||
The client is in the process of deregistering over the network
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="Error_Misconfigured" version="2.0">
|
||
<description>
|
||
The client is enabled, but is non-operational due a configuration error
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="Error_Network" version="2.0">
|
||
<description>
|
||
A network error occurred
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="Error_Registration" version="2.0">
|
||
<description>
|
||
An error occurred during registration
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="Quiescent" version="2.0">
|
||
<description>
|
||
This state indicates that the client has been disabled and is waiting for active session(s) to terminate before transitioning to the disabled state
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="Disabled" version="2.0">
|
||
<description>
|
||
The client is disabled
|
||
</description>
|
||
</enumeration>
|
||
</string>
|
||
<default type="object" value="Disabled"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Alias" access="readWrite" activeNotify="canDeny" version="2.0">
|
||
<description>
|
||
{{datatype|expand}}
|
||
</description>
|
||
<syntax>
|
||
<dataType ref="Alias"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="H235Authentication" access="readWrite" version="2.0">
|
||
<description>
|
||
Enables or disables usage of H.235 security baseline security profile as defined in {{bibref|H.235.1}}.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
<default type="object" value="false"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="AuthPassword" access="readWrite" version="2.0">
|
||
<description>
|
||
Password to be used when H.235 is enabled.
|
||
</description>
|
||
<syntax hidden="true">
|
||
<string/>
|
||
<default type="object" value=""/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="SendersID" access="readWrite" version="2.0">
|
||
<description>
|
||
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.
|
||
</description>
|
||
<syntax>
|
||
<string/>
|
||
<default type="object" value=""/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Network" access="readWrite" version="2.0">
|
||
<description>
|
||
H.323 network with which this H.323 client is associated.
|
||
{{reference}}
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="256"/>
|
||
<pathRef refType="strong" targetParent=".H323.Network." targetType="row"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="H323ID" access="readWrite" version="2.0">
|
||
<description>
|
||
The H.323 ID assigned to the client.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="32"/>
|
||
</string>
|
||
<default type="object" value=""/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="MaxSessions" access="readWrite" version="2.0">
|
||
<description>
|
||
Limit on the number of simultaneous voice sessions across this {{object}}. This MUST be less than or equal to {{param|.Capabilities.MaxSessionCount}}.
|
||
A value of zero indicates no explicit limit on the number of sessions.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
<default type="object" value="0"/>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.H323.Network.{i}." access="readWrite" numEntriesParameter="NetworkNumberOfEntries" minEntries="0" maxEntries="unbounded" version="2.0">
|
||
<description>
|
||
This object models a H.323 network (a network as described in {{bibref|TR-104i2|Section 4.2}}).
|
||
</description>
|
||
<uniqueKey functional="false">
|
||
<parameter ref="Alias"/>
|
||
</uniqueKey>
|
||
<parameter name="Enable" access="readWrite" version="2.0">
|
||
<description>
|
||
Enable or disable this {{object}}. Starts the DNS resolving when enabled.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
<default type="object" value="false"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="QuiescentMode" access="readWrite" version="2.0">
|
||
<description>
|
||
If {{true}}, when {{param|Enable}} is set to {{false}} in-progress sessions remain intact, but no new sessions are allowed. When all sessions are terminated, the {{object}} is disabled.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Status" access="readOnly" version="2.0">
|
||
<description>
|
||
Indicates the status of this network.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="Up" version="2.0"/>
|
||
<enumeration value="Resolving" version="2.0"/>
|
||
<enumeration value="Error_DNS" version="2.0"/>
|
||
<enumeration value="Error_Other" version="2.0"/>
|
||
<enumeration value="Disabled" version="2.0"/>
|
||
</string>
|
||
<default type="object" value="Disabled"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Alias" access="readWrite" activeNotify="canDeny" version="2.0">
|
||
<description>
|
||
{{datatype|expand}}
|
||
</description>
|
||
<syntax>
|
||
<dataType ref="Alias"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Gatekeeper" access="readWrite" version="2.0">
|
||
<description>
|
||
Host name or IP address of H.323 Gatekeeper.
|
||
</description>
|
||
<syntax>
|
||
<string/>
|
||
<default type="object" value=""/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="GatekeeperPort" access="readWrite" version="2.0">
|
||
<description>
|
||
Destination port to be used in connecting to the H.323 Gatekeeper.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
<default type="object" value="1719"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="GatekeeperID" access="readWrite" version="2.0">
|
||
<description>
|
||
Gatekeeper ID.
|
||
</description>
|
||
<syntax>
|
||
<string/>
|
||
<default type="object" value=""/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="TimeToLive" access="readWrite" version="2.0">
|
||
<description>
|
||
Defines the TimeToLive specification in the registration with the Gatekeeper in {{units}}.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<units value="seconds"/>
|
||
</unsignedInt>
|
||
<default type="object" value="86400"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="DSCPMark" access="readWrite" version="2.0">
|
||
<description>
|
||
Diffserv code point to be used for outgoing H.323 signaling packets.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<range minInclusive="0" maxInclusive="63"/>
|
||
</unsignedInt>
|
||
<default type="object" value="0"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="VLANIDMark" access="readWrite" version="2.0">
|
||
<description>
|
||
VLAN ID (as defined in {{bibref|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 {{param}} or {{param|EthernetPriorityMark}} is greater than zero, then the outgoing frames MUST be tagged. Otherwise, the outgoing frames MAY be tagged or untagged.
|
||
</description>
|
||
<syntax>
|
||
<int>
|
||
<range minInclusive="-1"/>
|
||
</int>
|
||
<default type="object" value="-1"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="EthernetPriorityMark" access="readWrite" version="2.0">
|
||
<description>
|
||
Ethernet priority code (as defined in {{bibref|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 {{param|VLANIDMark}} or {{param}} is greater than zero, then the outgoing frames MUST be tagged. Otherwise, the outgoing frames MAY be tagged or untagged.
|
||
</description>
|
||
<syntax>
|
||
<int>
|
||
<range minInclusive="-1"/>
|
||
</int>
|
||
<default type="object" value="-1"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="STUNEnable" access="readWrite" version="2.0">
|
||
<description>
|
||
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.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
<default type="object" value="false"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="STUNServer" access="readWrite" version="2.0">
|
||
<description>
|
||
Domain name or IP address of the STUN server.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="256"/>
|
||
</string>
|
||
<default type="object" value=""/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="NonVoiceBandwidthReservedUpstream" access="readWrite" version="2.0">
|
||
<description>
|
||
For bandwidth-based admission control, a session can proceed only if there is {{param}} {{units}} 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.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<units value="bits per second"/>
|
||
</unsignedInt>
|
||
<default type="object" value="0"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="NonVoiceBandwidthReservedDownstream" access="readWrite" version="2.0">
|
||
<description>
|
||
For bandwidth-based admission control, a session can proceed only if there is {{param}} {{units}} 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.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<units value="bits per second"/>
|
||
</unsignedInt>
|
||
<default type="object" value="0"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="MaxSessions" access="readWrite" version="2.0">
|
||
<description>
|
||
Limit on the number of simultaneous voice sessions across all {{object|.H323.Client.}} referencing this {{object}}. This MUST be less than or equal to {{param|.Capabilities.MaxSessionCount}}.
|
||
A value of zero indicates no explicit limit on the number of sessions.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
<default type="object" value="0"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="VoIPProfile" access="readWrite" version="2.0">
|
||
<description>
|
||
VoIP profile to use with this network.
|
||
{{reference}}
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="256"/>
|
||
<pathRef refType="strong" targetParent=".VoIPProfile." targetType="row"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="CodecList" access="readWrite" version="2.0">
|
||
<description>
|
||
{{list}} {{reference}}
|
||
The CPE SHOULD use the first enabled item in the list among those supported by the remote endpoint and consistent with the available bandwidth.
|
||
</description>
|
||
<syntax>
|
||
<list/>
|
||
<string>
|
||
<pathRef refType="strong" targetParent=".CodecProfile." targetType="row"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.Trunk.{i}." access="readWrite" numEntriesParameter="TrunkNumberOfEntries" minEntries="0" maxEntries="unbounded" version="2.0">
|
||
<description>
|
||
Trunk table.
|
||
The {{object}} holds all parameters a CPE needs to set up a trunk connection with an NGN, as defined in {{bibref|ETSI_TS_181_019}}.
|
||
</description>
|
||
<uniqueKey functional="false">
|
||
<parameter ref="Alias"/>
|
||
</uniqueKey>
|
||
<parameter name="Enable" access="readWrite" version="2.0">
|
||
<description>
|
||
Enables or disables this trunk.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
<default type="object" value="false"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="QuiescentMode" access="readWrite" version="2.0">
|
||
<description>
|
||
If {{true}}, when {{param|Enable}} is set to {{false}} in-progress sessions remain intact, but no new sessions are allowed. When all sessions are terminated, the {{object}} is disabled.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Status" access="readOnly" version="2.0">
|
||
<description>
|
||
Indicates the status of this trunk.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="Up" version="2.0"/>
|
||
<enumeration value="Initializing" version="2.0"/>
|
||
<enumeration value="Registering" version="2.0"/>
|
||
<enumeration value="Unregistering" version="2.0"/>
|
||
<enumeration value="Error" version="2.0"/>
|
||
<enumeration value="Testing" version="2.0"/>
|
||
<enumeration value="Disabled" version="2.0"/>
|
||
</string>
|
||
<default type="object" value="Disabled"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Alias" access="readWrite" activeNotify="canDeny" version="2.0">
|
||
<description>
|
||
{{datatype|expand}}
|
||
</description>
|
||
<syntax>
|
||
<dataType ref="Alias"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Origin" access="readOnly" version="2.0">
|
||
<description>
|
||
Mechanism via which the {{object}} was assigned. {{enum}}
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="AutoConfigured" version="2.0">
|
||
<description>
|
||
Automatically generated, for example by a ESBC that auto-creates {{object}} objects.
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="Static" version="2.0">
|
||
<description>
|
||
For example, present in the factory default configuration, created by the ACS, or created by some other management entity (e.g. via a GUI).
|
||
</description>
|
||
</enumeration>
|
||
</string>
|
||
<default type="object" value="Static"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Name" access="readWrite" version="2.0">
|
||
<description>
|
||
Name of the trunk.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="16"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="DDIRange" access="readWrite" version="2.0">
|
||
<description>
|
||
{{list}} 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 {{object|.Trunk}} is automatically adapted and each value of the {{param}} MUST be represented in corresponding {{param|.CallControl.Line.{i}.DirectoryNumber}} parameter.
|
||
If this trunk has a {{object|.SIP.Client.}} provider and {{param|.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 {{param|Origin}} is {{enum|Static|Origin}}.
|
||
</description>
|
||
<syntax>
|
||
<list/>
|
||
<string/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="LineObjectCreation" access="readWrite" version="2.0">
|
||
<description>
|
||
When {{true}}, a {{object|.CallControl.Line.{i}.}} instance SHOULD be created automatically for each identity within the ranges specified by {{param|DDIRange}}.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="MaxChannels" access="readWrite" version="2.0">
|
||
<description>
|
||
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.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="MaxOutboundChannelCount" access="readWrite" version="2.0">
|
||
<description>
|
||
Maximal number of simultaneous communication channels in outbound direction supported across this trunk. The maximum number cannot exceed {{param|MaxChannels}} - {{param|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.
|
||
</description>
|
||
<syntax>
|
||
<int>
|
||
<range minInclusive="-1"/>
|
||
</int>
|
||
<default type="object" value="-1"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="MaxInboundChannelCount" access="readWrite" version="2.0">
|
||
<description>
|
||
Maximal number of simultaneous communication channels in inbound direction supported across this trunk. The maximum number cannot exceed {{param|MaxChannels}} - {{param|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.
|
||
</description>
|
||
<syntax>
|
||
<int>
|
||
<range minInclusive="-1"/>
|
||
</int>
|
||
<default type="object" value="-1"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="CodecPriority" access="readWrite" version="2.0">
|
||
<description>
|
||
The {{param}} option controls which end of an inbound call leg will have priority over the negotiation of codecs.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="Local" version="2.0"/>
|
||
<enumeration value="Remote" version="2.0"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Provider" access="readWrite" version="2.0">
|
||
<description>
|
||
SIP client or ISDN interface associated with the identities represented by this trunk.
|
||
{{reference}}
|
||
This parameter can only be modified if {{param|Origin}} is {{enum|Static|Origin}}.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="256"/>
|
||
<pathRef refType="strong" targetParent=".SIP.Client. .ISDN.BRI. .ISDN.PRI." targetType="row"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.CallControl." access="readOnly" minEntries="1" maxEntries="1" version="2.0">
|
||
<description>
|
||
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 {{object|.Interwork}} table which is used in case of switching capabilities.
|
||
</description>
|
||
<parameter name="MaxNumberOfLines" access="readWrite" version="2.0">
|
||
<description>
|
||
Maximum number of {{object|Line.{i}.}} in {{object}}.
|
||
This value cannot be greater than {{param|.Capabilities.MaxLineCount}}.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="MaxNumberOfExtensions" access="readWrite" version="2.0">
|
||
<description>
|
||
Maximum number of {{object|Extension.{i}.}} in {{object}}.
|
||
This value cannot be greater than {{param|.Capabilities.MaxExtensionCount}}.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="LineNumberOfEntries" access="readOnly" version="2.0">
|
||
<description>
|
||
{{numentries}}
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="ExtensionNumberOfEntries" access="readOnly" version="2.0">
|
||
<description>
|
||
{{numentries}}
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="MailboxNumberOfEntries" access="readOnly" version="2.0">
|
||
<description>
|
||
{{numentries}}
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="IncomingMapNumberOfEntries" access="readOnly" version="2.0">
|
||
<description>
|
||
{{numentries}}
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="OutgoingMapNumberOfEntries" access="readOnly" version="2.0">
|
||
<description>
|
||
{{numentries}}
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="NumberingPlanNumberOfEntries" access="readOnly" version="2.0">
|
||
<description>
|
||
{{numentries}}
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="GroupNumberOfEntries" access="readOnly" version="2.0">
|
||
<description>
|
||
{{numentries}}
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.CallControl.Line.{i}." access="readWrite" numEntriesParameter="LineNumberOfEntries" enableParameter="Enable" minEntries="0" maxEntries="unbounded" version="2.0">
|
||
<description>
|
||
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 {{param|.Capabilities.MaxLineCount}}.
|
||
</description>
|
||
<uniqueKey>
|
||
<parameter ref="DirectoryNumber"/>
|
||
</uniqueKey>
|
||
<uniqueKey functional="false">
|
||
<parameter ref="Alias"/>
|
||
</uniqueKey>
|
||
<parameter name="Enable" access="readWrite" version="2.0">
|
||
<description>
|
||
Enable or disable this line.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
<default type="object" value="false"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="QuiescentMode" access="readWrite" version="2.0">
|
||
<description>
|
||
If {{true}}, when {{param|Enable}} is set to {{false}} in-progress sessions remain intact, but no new sessions are allowed. When all sessions are terminated, the {{object}} is disabled.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Status" access="readOnly" version="2.0">
|
||
<description>
|
||
Indicates the status of this line.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="Up" version="2.0"/>
|
||
<enumeration value="Error" version="2.0"/>
|
||
<enumeration value="Testing" version="2.0"/>
|
||
<enumeration value="Quiescent" version="2.0"/>
|
||
<enumeration value="Disabled" version="2.0"/>
|
||
</string>
|
||
<default type="object" value="Disabled"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Alias" access="readWrite" activeNotify="canDeny" version="2.0">
|
||
<description>
|
||
{{datatype|expand}}
|
||
</description>
|
||
<syntax>
|
||
<dataType ref="Alias"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="CallStatus" access="readOnly" version="2.0">
|
||
<description>
|
||
Indicates the call status for this line.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="Idle" version="2.0"/>
|
||
<enumeration value="Dialing" version="2.0"/>
|
||
<enumeration value="Delivered" version="2.0"/>
|
||
<enumeration value="Connected" version="2.0"/>
|
||
<enumeration value="Alerting" version="2.0"/>
|
||
<enumeration value="Disconnected" version="2.0"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Origin" access="readOnly" version="2.0">
|
||
<description>
|
||
Mechanism via which the {{object}} instance was created.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="Static" version="2.0">
|
||
<description>
|
||
explicitly created by the ACS or some other management entity, e.g. via a GUI
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="DDIRange" version="2.0">
|
||
<description>
|
||
created by the CPE according to the {{param|.Trunk.{i}.DDIRange}} setting of the associated {{object|.Trunk.{i}.}} in {{param|Provider}}
|
||
</description>
|
||
</enumeration>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="DirectoryNumber" access="readWrite" version="2.0">
|
||
<description>
|
||
Directory number associated with this line.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="32"/>
|
||
</string>
|
||
<default type="object" value=""/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Provider" access="readWrite" version="2.0">
|
||
<description>
|
||
Provider for the line. The value MUST be the path name of a row in one of the following tables:
|
||
{{reference}}
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="256"/>
|
||
<pathRef refType="strong" targetParent=".SIP.Client. .H323.Client. .ISDN.BRI. .ISDN.PRI. .POTS.FXO. .Trunk." targetType="row"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="CallingFeatures" access="readWrite" version="2.0">
|
||
<description>
|
||
Set of calling features to apply to this line.
|
||
{{reference}}
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="256"/>
|
||
<pathRef refType="strong" targetParent="#.CallingFeatures.Set." targetType="row"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.CallControl.Line.{i}.Stats." access="readOnly" minEntries="1" maxEntries="1" version="2.0">
|
||
<description>
|
||
Statistics for this {{object|#}} 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 {{param|#.Status}} parameter transitions to a down state after the line is disabled) or when the line becomes administratively up (i.e. the line's {{param|#.Enable}} parameter transitions from {{false}} to {{true}}).
|
||
</description>
|
||
</object>
|
||
<object name="VoiceService.{i}.CallControl.Line.{i}.Stats.IncomingCalls." access="readOnly" minEntries="1" maxEntries="1" version="2.0">
|
||
<description>
|
||
Statistics for incoming calls.
|
||
</description>
|
||
<parameter name="CallsReceived" access="readOnly" version="2.0">
|
||
<description>
|
||
Total number of received calls to the line.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="CallsConnected" access="readOnly" version="2.0">
|
||
<description>
|
||
Total number of calls that successfully completed call setup signaling.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="CallsFailed" access="readOnly" version="2.0">
|
||
<description>
|
||
Total number of calls that failed to successfully complete call setup signaling.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="CallsDropped" access="readOnly" version="2.0">
|
||
<description>
|
||
Total calls that were successfully connected, but dropped unexpectedly while in progress without explicit user termination.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="TotalCallTime" access="readOnly" activeNotify="canDeny" version="2.0">
|
||
<description>
|
||
Cumulative call duration in {{units}}.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<units value="seconds"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.CallControl.Line.{i}.Stats.OutgoingCalls." access="readOnly" minEntries="1" maxEntries="1" version="2.0">
|
||
<description>
|
||
Statistics for outgoing calls.
|
||
</description>
|
||
<parameter name="CallsAttempted" access="readOnly" version="2.0">
|
||
<description>
|
||
Total number of outgoing calls attempted from the line.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="CallsConnected" access="readOnly" version="2.0">
|
||
<description>
|
||
Total number of calls that successfully completed call setup signaling.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="CallsFailed" access="readOnly" version="2.0">
|
||
<description>
|
||
Total number of calls that failed to successfully complete call setup signaling.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="CallsDropped" access="readOnly" version="2.0">
|
||
<description>
|
||
Total calls that were successfully connected, but dropped unexpectedly while in progress without explicit user termination.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="TotalCallTime" access="readOnly" activeNotify="canDeny" version="2.0">
|
||
<description>
|
||
Cumulative call duration in {{units}}.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<units value="seconds"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.CallControl.Line.{i}.Stats.RTP." access="readOnly" minEntries="1" maxEntries="1" version="2.0">
|
||
<description>
|
||
RTP statistic parameters.
|
||
</description>
|
||
<parameter name="PacketsReceived" access="readOnly" activeNotify="canDeny" version="2.0">
|
||
<description>
|
||
Total number of RTP packets received.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="PacketsSent" access="readOnly" activeNotify="canDeny" version="2.0">
|
||
<description>
|
||
Total number of RTP packets sent.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="PacketsLost" access="readOnly" activeNotify="canDeny" version="2.0">
|
||
<description>
|
||
Total number of RTP packets that have been lost.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="BytesSent" access="readOnly" activeNotify="canDeny" version="2.0">
|
||
<description>
|
||
Total number of bytes sent.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="BytesReceived" access="readOnly" activeNotify="canDeny" version="2.0">
|
||
<description>
|
||
Total number of bytes received.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.CallControl.Line.{i}.Stats.DSP." access="readOnly" minEntries="1" maxEntries="1" version="2.0">
|
||
<description>
|
||
DSP statistic parameters.
|
||
</description>
|
||
<parameter name="Overruns" access="readOnly" activeNotify="canDeny" version="2.0">
|
||
<description>
|
||
Total number of times the receive jitter buffer has overrun.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Underruns" access="readOnly" activeNotify="canDeny" version="2.0">
|
||
<description>
|
||
Total number of times the receive jitter buffer has underrun.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.CallControl.Extension.{i}." access="readWrite" numEntriesParameter="ExtensionNumberOfEntries" enableParameter="Enable" minEntries="0" maxEntries="unbounded" version="2.0">
|
||
<description>
|
||
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 {{param|.Capabilities.MaxExtensionCount}}.
|
||
</description>
|
||
<uniqueKey>
|
||
<parameter ref="ExtensionNumber"/>
|
||
</uniqueKey>
|
||
<uniqueKey functional="false">
|
||
<parameter ref="Alias"/>
|
||
</uniqueKey>
|
||
<parameter name="Enable" access="readWrite" version="2.0">
|
||
<description>
|
||
Enable or disable this extension.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
<default type="object" value="false"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="QuiescentMode" access="readWrite" version="2.0">
|
||
<description>
|
||
If {{true}}, when {{param|Enable}} is set to {{false}} in-progress sessions remain intact, but no new sessions are allowed. When all sessions are terminated, the {{object}} is disabled.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Status" access="readOnly" version="2.0">
|
||
<description>
|
||
Indicates the status of this extension.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="Up" version="2.0"/>
|
||
<enumeration value="Initializing" version="2.0"/>
|
||
<enumeration value="Error" version="2.0"/>
|
||
<enumeration value="Testing" version="2.0"/>
|
||
<enumeration value="Quiescent" version="2.0"/>
|
||
<enumeration value="Disabled" version="2.0"/>
|
||
</string>
|
||
<default type="object" value="Disabled"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Alias" access="readWrite" activeNotify="canDeny" version="2.0">
|
||
<description>
|
||
{{datatype|expand}}
|
||
</description>
|
||
<syntax>
|
||
<dataType ref="Alias"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="CallStatus" access="readOnly" version="2.0">
|
||
<description>
|
||
Indicates the call status for this extension.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="Idle" version="2.0"/>
|
||
<enumeration value="Dialing" version="2.0"/>
|
||
<enumeration value="Delivered" version="2.0"/>
|
||
<enumeration value="Connected" version="2.0"/>
|
||
<enumeration value="Alerting" version="2.0"/>
|
||
<enumeration value="Disconnected" version="2.0"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Origin" access="readOnly" version="2.0">
|
||
<description>
|
||
Mechanism via which the {{object}} object was assigned. {{enum}}
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="AutoConfigured" version="2.0">
|
||
<description>
|
||
Automatically generated, for example by a ESBC that auto-creates {{object}} objects
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="Static" version="2.0">
|
||
<description>
|
||
For example, present in the factory default configuration, created by the ACS, or created by some other management entity (e.g. via a GUI).
|
||
</description>
|
||
</enumeration>
|
||
</string>
|
||
<default type="object" value="Static"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Name" access="readWrite" version="2.0">
|
||
<description>
|
||
The name of this extension.
|
||
This name will also be used for CallerIdName functionality and for displaying on screen of handset, etc...
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="256"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="ExtensionNumber" access="readWrite" version="2.0">
|
||
<description>
|
||
The number assigned to this extension for internal calls.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="32"/>
|
||
</string>
|
||
<default type="object" value=""/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Provider" access="readWrite" version="2.0">
|
||
<description>
|
||
Provider for the extension. The value MUST be the path name of a row in one of the following tables:
|
||
{{reference}}
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="256"/>
|
||
<pathRef refType="strong" targetParent=".SIP.Registrar.{i}.Account. .ISDN.BRI. .ISDN.PRI. .POTS.FXS. .DECT.Portable. .Terminal. .CallControl.Group." targetType="row"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="NumberingPlan" access="readWrite" version="2.0">
|
||
<description>
|
||
Numbering plan to be used for outgoing calls.
|
||
{{reference}}
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="256"/>
|
||
<pathRef refType="strong" targetParent=".CallControl.NumberingPlan." targetType="row"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="CallingFeatures" access="readWrite" version="2.0">
|
||
<description>
|
||
Set of calling features to apply to this extension.
|
||
{{reference}}
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="256"/>
|
||
<pathRef refType="strong" targetParent="#.CallingFeatures.Set." targetType="row"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="CallWaitingStatus" access="readOnly" version="2.0">
|
||
<description>
|
||
Status of endpoint managed call waiting, if supported. {{enum}}
|
||
This parameter SHOULD NOT be present if the CPE does not support endpoint managed call waiting.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="Disabled" version="2.0"/>
|
||
<enumeration value="Idle" version="2.0"/>
|
||
<enumeration value="SecondaryRinging" version="2.0"/>
|
||
<enumeration value="SecondaryConnecting" version="2.0"/>
|
||
<enumeration value="SecondaryConnected" version="2.0"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="ConferenceCallingStatus" access="readOnly" version="2.0">
|
||
<description>
|
||
Status of endpoint managed conference calling, if supported. {{enum}}
|
||
This parameter SHOULD NOT be present if the CPE does not support endpoint managed conference calling.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="Disabled" version="2.0"/>
|
||
<enumeration value="Idle" version="2.0"/>
|
||
<enumeration value="SecondaryCalling" version="2.0"/>
|
||
<enumeration value="SecondaryConnecting" version="2.0"/>
|
||
<enumeration value="SecondaryConnected" version="2.0"/>
|
||
<enumeration value="InConferenceCall" version="2.0"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="ConferenceCallingSessionCount" access="readOnly" version="2.0">
|
||
<description>
|
||
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.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="VoiceMail" access="readWrite" version="2.0">
|
||
<description>
|
||
Voice mail to use when the {{object}} is not responding.
|
||
{{reference}}
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="256"/>
|
||
<pathRef refType="strong" targetParent=".CallControl.Mailbox." targetType="row"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.CallControl.Extension.{i}.Stats." access="readOnly" minEntries="1" maxEntries="1" version="2.0">
|
||
<description>
|
||
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 {{param|#.Status}} parameter transitions to a down state after the extension is disabled) or when the extension becomes administratively up (i.e. the extension's {{param|#.Enable}} parameter transitions from {{false}} to {{true}}).
|
||
</description>
|
||
</object>
|
||
<object name="VoiceService.{i}.CallControl.Extension.{i}.Stats.IncomingCalls." access="readOnly" minEntries="1" maxEntries="1" version="2.0">
|
||
<description>
|
||
Statistics for incoming calls.
|
||
</description>
|
||
<parameter name="CallsReceived" access="readOnly" version="2.0">
|
||
<description>
|
||
Total number of received calls to the extension.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="CallsConnected" access="readOnly" version="2.0">
|
||
<description>
|
||
Total number of calls that successfully completed call setup signaling.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="CallsFailed" access="readOnly" version="2.0">
|
||
<description>
|
||
Total number of calls that failed to successfully complete call setup signaling.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="CallsDropped" access="readOnly" version="2.0">
|
||
<description>
|
||
Total calls that were successfully connected, but dropped unexpectedly while in progress without explicit user termination.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="TotalCallTime" access="readOnly" activeNotify="canDeny" version="2.0">
|
||
<description>
|
||
Cumulative call duration in {{units}}.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<units value="seconds"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.CallControl.Extension.{i}.Stats.OutgoingCalls." access="readOnly" minEntries="1" maxEntries="1" version="2.0">
|
||
<description>
|
||
Statistics for outgoing calls.
|
||
</description>
|
||
<parameter name="CallsAttempted" access="readOnly" version="2.0">
|
||
<description>
|
||
Total number of outgoing calls attempted from the extension.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="CallsConnected" access="readOnly" version="2.0">
|
||
<description>
|
||
Total number of calls that successfully completed call setup signaling.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="CallsFailed" access="readOnly" version="2.0">
|
||
<description>
|
||
Total number of calls that failed to successfully complete call setup signaling.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="CallsDropped" access="readOnly" version="2.0">
|
||
<description>
|
||
Total calls that were successfully connected, but dropped unexpectedly while in progress without explicit user termination.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="TotalCallTime" access="readOnly" activeNotify="canDeny" version="2.0">
|
||
<description>
|
||
Cumulative call duration in {{units}}.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<units value="seconds"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.CallControl.Extension.{i}.Stats.RTP." access="readOnly" minEntries="1" maxEntries="1" version="2.0">
|
||
<description>
|
||
RTP statistic parameters.
|
||
</description>
|
||
<parameter name="PacketsReceived" access="readOnly" activeNotify="canDeny" version="2.0">
|
||
<description>
|
||
Total number of RTP packets received.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="PacketsSent" access="readOnly" activeNotify="canDeny" version="2.0">
|
||
<description>
|
||
Total number of RTP packets sent.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="PacketsLost" access="readOnly" activeNotify="canDeny" version="2.0">
|
||
<description>
|
||
Total number of RTP packets that have been lost.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="BytesSent" access="readOnly" activeNotify="canDeny" version="2.0">
|
||
<description>
|
||
Total number of bytes sent.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="BytesReceived" access="readOnly" activeNotify="canDeny" version="2.0">
|
||
<description>
|
||
Total number of bytes received.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.CallControl.Extension.{i}.Stats.DSP." access="readOnly" minEntries="1" maxEntries="1" version="2.0">
|
||
<description>
|
||
DSP statistic parameters.
|
||
</description>
|
||
<parameter name="Overruns" access="readOnly" activeNotify="canDeny" version="2.0">
|
||
<description>
|
||
Total number of times the receive jitter buffer has overrun.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Underruns" access="readOnly" activeNotify="canDeny" version="2.0">
|
||
<description>
|
||
Total number of times the receive jitter buffer has underrun.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.CallControl.Group.{i}." access="readWrite" numEntriesParameter="GroupNumberOfEntries" minEntries="0" maxEntries="unbounded" version="2.0">
|
||
<description>
|
||
This object models an extension as a group of extensions.
|
||
</description>
|
||
<uniqueKey functional="false">
|
||
<parameter ref="Alias"/>
|
||
</uniqueKey>
|
||
<parameter name="Alias" access="readWrite" activeNotify="canDeny" version="2.0">
|
||
<description>
|
||
{{datatype|expand}}
|
||
</description>
|
||
<syntax>
|
||
<dataType ref="Alias"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Extensions" access="readWrite" version="2.0">
|
||
<description>
|
||
{{list}} If this parameter is null the group is treated as a group that contains all extensions.
|
||
{{reference}}
|
||
</description>
|
||
<syntax>
|
||
<list/>
|
||
<string>
|
||
<pathRef refType="strong" targetParent=".CallControl.Extension." targetType="row"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="RingType" access="readWrite" version="2.0">
|
||
<description>
|
||
Defines the way of ringing for the extensions in this group. {{enum}}
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="Simultaneous" version="2.0">
|
||
<description>
|
||
all extensions ring together
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="Hierarchical" version="2.0">
|
||
<description>
|
||
extensions ring one by one in the order defined in {{param|Extensions}}. If the ringing extension doesn’t answer after {{param|RingTimeout}}, the next extension in the list is tried
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="Cyclic" version="2.0">
|
||
<description>
|
||
as Hierarchical, but the list is not reset between incoming calls
|
||
</description>
|
||
</enumeration>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="RingTimeout" access="readWrite" version="2.0">
|
||
<description>
|
||
The time (in {{units}}) to wait for extension reply before trying the next extension.
|
||
Only applicable if {{param|RingType}} = {{enum|Hierarchical|RingType}} or {{enum|Cyclic|RingType}}.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<units value="seconds"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.CallControl.Mailbox.{i}." access="readWrite" numEntriesParameter="MailboxNumberOfEntries" enableParameter="Enable" minEntries="0" maxEntries="unbounded" version="2.0">
|
||
<description>
|
||
Voice mail configuration related to a particular extension.
|
||
</description>
|
||
<uniqueKey functional="false">
|
||
<parameter ref="Alias"/>
|
||
</uniqueKey>
|
||
<parameter name="Enable" access="readWrite" version="2.0">
|
||
<description>
|
||
Enables or disables this entry.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
<default type="object" value="false"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Alias" access="readWrite" activeNotify="canDeny" version="2.0">
|
||
<description>
|
||
{{datatype|expand}}
|
||
</description>
|
||
<syntax>
|
||
<dataType ref="Alias"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="MaxMsg" access="readWrite" version="2.0">
|
||
<description>
|
||
This limits the number of messages in a voicemail folder.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="MaxMessageTime" access="readWrite" version="2.0">
|
||
<description>
|
||
Defines the maximum amount of time in {{units}} 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.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<units value="seconds"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="MinSize" access="readWrite" version="2.0">
|
||
<description>
|
||
Minimal size in {{units}} of the voicemail box.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<units value="seconds"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="SMTPServerAddress" access="readWrite" version="2.0">
|
||
<description>
|
||
SMTP server FQDN or IP Address used for voicemail notifications.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="256"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="SMTPServerPort" access="readWrite" version="2.0">
|
||
<description>
|
||
SMTP server port for voicemail notifications.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<range minInclusive="0" maxInclusive="65535"/>
|
||
</unsignedInt>
|
||
<default type="object" value="25"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="SMTPUser" access="readWrite" version="2.0">
|
||
<description>
|
||
SMTP user name.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="256"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="SMTPPassword" access="readWrite" version="2.0">
|
||
<description>
|
||
SMTP password.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="256"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="SMTPAuthenticationType" access="readWrite" version="2.0">
|
||
<description>
|
||
Type of authentication used to connect to the SMTP server.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="None" version="2.0"/>
|
||
<enumeration value="SSL" version="2.0"/>
|
||
<enumeration value="TLS" version="2.0"/>
|
||
<enumeration value="Auto" version="2.0"/>
|
||
</string>
|
||
<default type="object" value="None"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="SMTPFrom" access="readWrite" version="2.0">
|
||
<description>
|
||
Sender's email address.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="256"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.CallControl.IncomingMap.{i}." access="readWrite" numEntriesParameter="IncomingMapNumberOfEntries" enableParameter="Enable" minEntries="0" maxEntries="unbounded" version="2.0">
|
||
<description>
|
||
The {{object}} 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).
|
||
</description>
|
||
<uniqueKey>
|
||
<parameter ref="Line"/>
|
||
<parameter ref="Extension"/>
|
||
</uniqueKey>
|
||
<uniqueKey functional="false">
|
||
<parameter ref="Alias"/>
|
||
</uniqueKey>
|
||
<parameter name="Enable" access="readWrite" version="2.0">
|
||
<description>
|
||
Enables or disables this entry.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
<default type="object" value="false"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Alias" access="readWrite" activeNotify="canDeny" version="2.0">
|
||
<description>
|
||
{{datatype|expand}}
|
||
</description>
|
||
<syntax>
|
||
<dataType ref="Alias"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Line" access="readWrite" version="2.0">
|
||
<description>
|
||
{{object|#.Line}} used by the call.
|
||
{{reference}}
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="256"/>
|
||
<pathRef refType="strong" targetParent=".CallControl.Line." targetType="row"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Extension" access="readWrite" version="2.0">
|
||
<description>
|
||
{{object|#.Extension}} that rings on incoming call.
|
||
{{reference}}
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="256"/>
|
||
<pathRef refType="strong" targetParent=".CallControl.Extension." targetType="row"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Order" access="readWrite" version="2.0">
|
||
<description>
|
||
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.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<range minInclusive="1"/>
|
||
</unsignedInt>
|
||
<default type="object" value="1"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Timeout" access="readWrite" version="2.0">
|
||
<description>
|
||
The time in {{units}} the extension will ring before it is considered that there was no reply.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<units value="seconds"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.CallControl.OutgoingMap.{i}." access="readWrite" numEntriesParameter="OutgoingMapNumberOfEntries" enableParameter="Enable" minEntries="0" maxEntries="unbounded" version="2.0">
|
||
<description>
|
||
The {{object}} is a table that is used to control which line is used when an extension makes a call.
|
||
</description>
|
||
<uniqueKey>
|
||
<parameter ref="Extension"/>
|
||
<parameter ref="Line"/>
|
||
</uniqueKey>
|
||
<uniqueKey functional="false">
|
||
<parameter ref="Alias"/>
|
||
</uniqueKey>
|
||
<parameter name="Enable" access="readWrite" version="2.0">
|
||
<description>
|
||
Enables or disables this entry.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
<default type="object" value="false"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Alias" access="readWrite" activeNotify="canDeny" version="2.0">
|
||
<description>
|
||
{{datatype|expand}}
|
||
</description>
|
||
<syntax>
|
||
<dataType ref="Alias"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="CLIPNoScreeningNumber" access="readWrite" version="2.0">
|
||
<description>
|
||
Public number to be presented outgoing calls, instead of the effective extension number.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="32"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Extension" access="readWrite" version="2.0">
|
||
<description>
|
||
{{object|#.Extension}} which makes the outgoing call.
|
||
{{reference}}
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="256"/>
|
||
<pathRef refType="strong" targetParent=".CallControl.Extension." targetType="row"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Line" access="readWrite" version="2.0">
|
||
<description>
|
||
Identifies the {{object|#.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 {{object|#.NumberingPlan}}.
|
||
{{reference}}
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="256"/>
|
||
<pathRef refType="strong" targetParent=".CallControl.Line." targetType="row"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Order" access="readWrite" version="2.0">
|
||
<description>
|
||
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.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<range minInclusive="1"/>
|
||
</unsignedInt>
|
||
<default type="object" value="1"/>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.CallControl.NumberingPlan.{i}." access="readWrite" numEntriesParameter="NumberingPlanNumberOfEntries" minEntries="0" maxEntries="unbounded" version="2.0">
|
||
<description>
|
||
Information related the numbering plan.
|
||
{{object}} 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).
|
||
</description>
|
||
<uniqueKey functional="false">
|
||
<parameter ref="Alias"/>
|
||
</uniqueKey>
|
||
<parameter name="Alias" access="readWrite" activeNotify="canDeny" version="2.0">
|
||
<description>
|
||
{{datatype|expand}}
|
||
</description>
|
||
<syntax>
|
||
<dataType ref="Alias"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="MinimumNumberOfDigits" access="readWrite" version="2.0">
|
||
<description>
|
||
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 {{param|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 {{object|.CallControl.NumberingPlan.{i}.PrefixInfo.{i}.}} commences only once {{param}} digits has been received.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<range minInclusive="1" maxInclusive="32"/>
|
||
</unsignedInt>
|
||
<default type="object" value="1"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="MaximumNumberOfDigits" access="readWrite" version="2.0">
|
||
<description>
|
||
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 {{object|.CallControl.NumberingPlan.{i}.PrefixInfo.{i}.}} has been found.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<range minInclusive="1" maxInclusive="32"/>
|
||
</unsignedInt>
|
||
<default type="object" value="15"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="InterDigitTimerStd" access="readWrite" version="2.0">
|
||
<description>
|
||
This timer is the maximum allowable time (expressed in {{units}}) between the dialing of digits. This timer is restarted every time a digit is dialed. Expiration of this timer indicates ''End of Dialing''.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<range minInclusive="1" maxInclusive="50000"/>
|
||
<units value="milliseconds"/>
|
||
</unsignedInt>
|
||
<default type="object" value="15000"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="InterDigitTimerOpen" access="readWrite" version="2.0">
|
||
<description>
|
||
This timer is the maximum allowable time (expressed in {{units}}) 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.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<range minInclusive="1" maxInclusive="50000"/>
|
||
<units value="milliseconds"/>
|
||
</unsignedInt>
|
||
<default type="object" value="3000"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="TerminationDigit" access="readWrite" version="2.0">
|
||
<description>
|
||
Digit that can be used by the subscriber to indicate that dialing has completed.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="1"/>
|
||
</string>
|
||
<default type="object" value="#"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="InvalidNumberTone" access="readWrite" version="2.0">
|
||
<description>
|
||
The tone that tells the user when the number dialed is determined to be invalid.
|
||
{{reference}}
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="256"/>
|
||
<pathRef refType="strong" targetParent=".Tone.Description." targetType="row"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="PrefixInfoMaxEntries" access="readOnly" version="2.0">
|
||
<description>
|
||
This is the maximum number of instances of {{object|.CallControl.NumberingPlan.{i}.PrefixInfo.{i}.}} that can be supported.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="PrefixInfoNumberOfEntries" access="readOnly" version="2.0">
|
||
<description>
|
||
Indicates the number of instances of {{object|.CallControl.NumberingPlan.{i}.PrefixInfo.{i}.}}.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.CallControl.NumberingPlan.{i}.PrefixInfo.{i}." access="readWrite" numEntriesParameter="PrefixInfoNumberOfEntries" enableParameter="Enable" minEntries="0" maxEntries="unbounded" version="2.0">
|
||
<description>
|
||
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, {{param|.CallControl.NumberingPlan.{i}.PrefixInfoMaxEntries}} and {{param|.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.
|
||
</description>
|
||
<uniqueKey functional="false">
|
||
<parameter ref="Alias"/>
|
||
</uniqueKey>
|
||
<parameter name="Alias" access="readWrite" activeNotify="canDeny" version="2.0">
|
||
<description>
|
||
{{datatype|expand}}
|
||
</description>
|
||
<syntax>
|
||
<dataType ref="Alias"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Enable" access="readWrite" version="2.0">
|
||
<description>
|
||
Enables or disables this entry.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
<default type="object" value="false"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="PrefixRange" access="readWrite" version="2.0">
|
||
<description>
|
||
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
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="42"/>
|
||
</string>
|
||
<default type="object" value=""/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="PrefixMinNumberOfDigits" access="readWrite" version="2.0">
|
||
<description>
|
||
This is the minimum number of allowable digits for the prefix range. Once the minimum number of digits has been reached, {{param|#.InterDigitTimerOpen}} will be used instead of {{param|#.InterDigitTimerStd}}.
|
||
If the minimum number of digits has been reached and the inter-digit timer expires, an outgoing request is initiated.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<range minInclusive="1" maxInclusive="40"/>
|
||
</unsignedInt>
|
||
<default type="object" value="1"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="PrefixMaxNumberOfDigits" access="readWrite" version="2.0">
|
||
<description>
|
||
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.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<range minInclusive="1" maxInclusive="40"/>
|
||
</unsignedInt>
|
||
<default type="object" value="1"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="NumberOfDigitsToRemove" access="readWrite" version="2.0">
|
||
<description>
|
||
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 {{param|PosOfDigitsToRemove}}.
|
||
Subsequently a search of {{object}} 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.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<range minInclusive="0" maxInclusive="40"/>
|
||
</unsignedInt>
|
||
<default type="object" value="0"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="PosOfDigitsToRemove" access="readWrite" version="2.0">
|
||
<description>
|
||
This parameter is used in conjunction with {{param|NumberOfDigitsToRemove}}. It specifies the position within the internal digit buffer from which the digits are to be removed.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<range minInclusive="0" maxInclusive="40"/>
|
||
</unsignedInt>
|
||
<default type="object" value="0"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="DialTone" access="readWrite" version="2.0">
|
||
<description>
|
||
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.
|
||
{{reference}}
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="256"/>
|
||
<pathRef refType="strong" targetParent=".Tone.Description." targetType="row"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="FacilityAction" access="readWrite" version="2.0">
|
||
<description>
|
||
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 {{bibref|TR-106}}.
|
||
When {{empty}} or the value is an unrecognized string (i.e. a Facility Action not supported by the CPE) normal outgoing requests are made.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="64"/>
|
||
<enumerationRef targetParam=".Capabilities.FacilityActions" nullValue=""/>
|
||
</string>
|
||
<default type="object" value=""/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="FacilityActionArgument" access="readWrite" version="2.0">
|
||
<description>
|
||
Optional argument associated with {{param|FacilityAction}}. The interpretation of the argument is dependent on a specific value of {{param|FacilityAction}}. {{reference}}
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="256"/>
|
||
<pathRef refType="weak" targetParent=".CallControl.Line. .CallControl.Extension. .CallControl.Mailbox." targetType="row"/>
|
||
</string>
|
||
<default type="object" value=""/>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.CallControl.CallingFeatures." access="readOnly" minEntries="1" maxEntries="1" version="2.0">
|
||
<description>
|
||
This object models the calling features that can be apply on {{object|.CallControl.Line}} or {{object|.CallControl.Extension}}.
|
||
</description>
|
||
<parameter name="SetNumberOfEntries" access="readOnly" version="2.0">
|
||
<description>
|
||
{{numentries}}
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.CallControl.CallingFeatures.Set.{i}." access="readWrite" numEntriesParameter="SetNumberOfEntries" minEntries="0" maxEntries="unbounded" version="2.0">
|
||
<description>
|
||
This object models a set of calling features that can be applied in {{object|.CallControl.Line.}} or {{object|.CallControl.Extension.}} objects.
|
||
</description>
|
||
<uniqueKey functional="false">
|
||
<parameter ref="Alias"/>
|
||
</uniqueKey>
|
||
<parameter name="Alias" access="readWrite" activeNotify="canDeny" version="2.0">
|
||
<description>
|
||
{{datatype|expand}}
|
||
</description>
|
||
<syntax>
|
||
<dataType ref="Alias"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="CallerIDEnable" access="readWrite" version="2.0">
|
||
<description>
|
||
Enable or disable the transmission of caller ID information on incoming calls (CLIP).
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="CallerIDNameEnable" access="readWrite" version="2.0">
|
||
<description>
|
||
Enable or disable the transmission of caller ID name information on incoming calls (CNIP).
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="CallWaitingEnable" access="readWrite" version="2.0">
|
||
<description>
|
||
Enables or disables call waiting in the Endpoint.
|
||
This parameter SHOULD NOT be present if the CPE does not support Endpoint managed call waiting.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="CallForwardUnconditionalEnable" access="readWrite" version="2.0">
|
||
<description>
|
||
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.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="CallForwardUnconditionalNumber" access="readWrite" version="2.0">
|
||
<description>
|
||
Directory number to which all incoming calls to this line are forwarded when {{param|CallForwardUnconditionalEnable}} is {{true}}.
|
||
This parameter SHOULD NOT be present if the CPE does not support Endpoint based call forwarding
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="32"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="CallForwardOnBusyEnable" access="readWrite" version="2.0">
|
||
<description>
|
||
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.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="CallForwardOnBusyNumber" access="readWrite" version="2.0">
|
||
<description>
|
||
Directory number to which all incoming calls to this line are forwarded when {{param|CallForwardOnBusyEnable}} is {{true}} and the line is busy.
|
||
This parameter SHOULD NOT be present if the CPE does not support Endpoint based call forwarding.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="32"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="CallForwardOnBusyRingTimeout" access="readWrite" version="2.0">
|
||
<description>
|
||
Delay in {{units}} 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.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<units value="seconds"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="CallForwardOnNoAnswerEnable" access="readWrite" version="2.0">
|
||
<description>
|
||
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.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="CallForwardOnNoAnswerNumber" access="readWrite" version="2.0">
|
||
<description>
|
||
Directory number to which all incoming calls to this line are forwarded when {{param|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.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="32"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="CallForwardOnNoAnswerRingTimeout" access="readWrite" version="2.0">
|
||
<description>
|
||
Delay in {{units}} 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.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<units value="seconds"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="CallTransferEnable" access="readWrite" version="2.0">
|
||
<description>
|
||
Enables or disables call transfer by the Endpoint.
|
||
This parameter SHOULD NOT be present if the CPE does not support Endpoint based call transfer.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="MWIEnable" access="readWrite" version="2.0">
|
||
<description>
|
||
Enables or disables Message Waiting Indication by the Endpoint.
|
||
This parameter SHOULD NOT be present if the CPE does not support MWI.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="VMWIEnable" access="readWrite" version="2.0">
|
||
<description>
|
||
Enables or disables Visual Message Waiting Indication.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="LineMessagesWaiting" access="readOnly" version="2.0">
|
||
<description>
|
||
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.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="AnonymousCallRejectionEnable" access="readWrite" version="2.0">
|
||
<description>
|
||
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.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="AnonymousCallEnable" access="readWrite" version="2.0">
|
||
<description>
|
||
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.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="DoNotDisturbEnable" access="readWrite" version="2.0">
|
||
<description>
|
||
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.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="RepeatDialEnable" access="readWrite" version="2.0">
|
||
<description>
|
||
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.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="VoiceMailEnable" access="readWrite" version="2.0">
|
||
<description>
|
||
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.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="CallPickUpEnable" access="readWrite" version="2.0">
|
||
<description>
|
||
Enable or disable Call Interception capability in the Endpoint.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="CCBSEnable" access="readWrite" version="2.0">
|
||
<description>
|
||
Enable or disable automatic recall on busy (Completion of Calls to Busy Subscriber) capability in the Endpoint.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="IIFCEnable" access="readWrite" version="2.0">
|
||
<description>
|
||
Enable or disable successive forwarding (Inhibition of Incoming Forwarded Calls) from the Endpoint.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="BlockForwardEnable" access="readWrite" version="2.0">
|
||
<description>
|
||
Allow or block any internal forward to the Endpoint.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="SecretForwarderEnable" access="readWrite" version="2.0">
|
||
<description>
|
||
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.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="FollowMeEnable" access="readWrite" version="2.0">
|
||
<description>
|
||
Enable or disable FollowMe capability in the Endpoint.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="CFTNumberOfEntries" access="readOnly" version="2.0">
|
||
<description>
|
||
{{numentries}}
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="SCFNumberOfEntries" access="readOnly" version="2.0">
|
||
<description>
|
||
{{numentries}}
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="SCREJNumberOfEntries" access="readOnly" version="2.0">
|
||
<description>
|
||
{{numentries}}
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="FollowMeNumberOfEntries" access="readOnly" version="2.0">
|
||
<description>
|
||
{{numentries}}
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.CallControl.CallingFeatures.Set.{i}.CFT.{i}." access="readWrite" numEntriesParameter="CFTNumberOfEntries" minEntries="0" maxEntries="unbounded" version="2.0">
|
||
<description>
|
||
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.
|
||
</description>
|
||
<uniqueKey functional="false">
|
||
<parameter ref="Alias"/>
|
||
</uniqueKey>
|
||
<parameter name="Enable" access="readWrite" version="2.0">
|
||
<description>
|
||
Whether this schedule is currently enabled.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Alias" access="readWrite" activeNotify="canDeny" version="2.0">
|
||
<description>
|
||
{{datatype|expand}}
|
||
</description>
|
||
<syntax>
|
||
<dataType ref="Alias"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Day" access="readWrite" version="2.0">
|
||
<description>
|
||
Day where the schedule active.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="Monday" version="2.0"/>
|
||
<enumeration value="Tuesday" version="2.0"/>
|
||
<enumeration value="Wednesday" version="2.0"/>
|
||
<enumeration value="Thursday" version="2.0"/>
|
||
<enumeration value="Friday" version="2.0"/>
|
||
<enumeration value="Saturday" version="2.0"/>
|
||
<enumeration value="Sunday" version="2.0"/>
|
||
<enumeration value="All" version="2.0">
|
||
<description>
|
||
For all days schedule
|
||
</description>
|
||
</enumeration>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="StartTime" access="readWrite" version="2.0">
|
||
<description>
|
||
Start time of the schedule in the form : hh:mm.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="5"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="EndTime" access="readWrite" version="2.0">
|
||
<description>
|
||
End time of the schedule in the form : hh:mm.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="5"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="ForwardedToNumber" access="readWrite" version="2.0">
|
||
<description>
|
||
Number to forward the call to.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="32"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.CallControl.CallingFeatures.Set.{i}.SCF.{i}." access="readWrite" numEntriesParameter="SCFNumberOfEntries" enableParameter="Enable" minEntries="0" maxEntries="unbounded" version="2.0">
|
||
<description>
|
||
This object defines a Selective Call Forwarding (SCF) that permit the user to forward calls to different destinations depending on the calling number.
|
||
</description>
|
||
<uniqueKey>
|
||
<parameter ref="CallingNumber"/>
|
||
</uniqueKey>
|
||
<uniqueKey functional="false">
|
||
<parameter ref="Alias"/>
|
||
</uniqueKey>
|
||
<parameter name="Enable" access="readWrite" version="2.0">
|
||
<description>
|
||
Enables or disables this Selective Call Forward.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
<default type="object" value="false"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Alias" access="readWrite" activeNotify="canDeny" version="2.0">
|
||
<description>
|
||
{{datatype|expand}}
|
||
</description>
|
||
<syntax>
|
||
<dataType ref="Alias"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="CallingNumber" access="readWrite" version="2.0">
|
||
<description>
|
||
Calling number concerned by the forward.
|
||
The CPE SHOULD perform an exact match with this string without any attempts at number normalization.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="32"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="ForwardedToNumber" access="readWrite" version="2.0">
|
||
<description>
|
||
Number to forward the call to.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="32"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.CallControl.CallingFeatures.Set.{i}.SCREJ.{i}." access="readWrite" numEntriesParameter="SCREJNumberOfEntries" enableParameter="Enable" minEntries="0" maxEntries="unbounded" version="2.0">
|
||
<description>
|
||
This object defines a Selective Call Rejection (SCREJ) that permit the user to selectively reject calls depending on the calling number.
|
||
</description>
|
||
<uniqueKey>
|
||
<parameter ref="CallingNumber"/>
|
||
</uniqueKey>
|
||
<uniqueKey functional="false">
|
||
<parameter ref="Alias"/>
|
||
</uniqueKey>
|
||
<parameter name="Enable" access="readWrite" version="2.0">
|
||
<description>
|
||
Enables or disables this Selective Call Rejection.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
<default type="object" value="false"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Alias" access="readWrite" activeNotify="canDeny" version="2.0">
|
||
<description>
|
||
{{datatype|expand}}
|
||
</description>
|
||
<syntax>
|
||
<dataType ref="Alias"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="CallingNumber" access="readWrite" version="2.0">
|
||
<description>
|
||
Calling number concerned by the reject.
|
||
The CPE SHOULD perform an exact match with this string without any attempts at number normalization.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="32"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.CallControl.CallingFeatures.Set.{i}.FollowMe.{i}." access="readWrite" numEntriesParameter="FollowMeNumberOfEntries" enableParameter="Enable" minEntries="0" maxEntries="unbounded" version="2.0">
|
||
<description>
|
||
This object defines the FollowMe destinations mapping definition, in the provided sequence order.
|
||
</description>
|
||
<uniqueKey functional="false">
|
||
<parameter ref="Alias"/>
|
||
</uniqueKey>
|
||
<uniqueKey>
|
||
<parameter ref="Number"/>
|
||
<parameter ref="Order"/>
|
||
</uniqueKey>
|
||
<parameter name="Enable" access="readWrite" version="2.0">
|
||
<description>
|
||
Enables or disables this FollowMe sequence item.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
<default type="object" value="false"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Alias" access="readWrite" activeNotify="canDeny" version="2.0">
|
||
<description>
|
||
{{datatype|expand}}
|
||
</description>
|
||
<syntax>
|
||
<dataType ref="Alias"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Delay" access="readWrite" version="2.0">
|
||
<description>
|
||
Delay in {{units}} before next FollowMe sequence item applies.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<units value="seconds"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Number" access="readWrite" version="2.0">
|
||
<description>
|
||
Directory number to which all incoming calls to this line are forwarded to after {{param|Delay}}, when {{param|#.FollowMeEnable}} is {{true}}. In this case, {{param|#.CallForwardOnNoAnswerNumber}} is not used.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="32"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Order" access="readWrite" version="2.0">
|
||
<description>
|
||
For a given {{param|Number}}, defines the order of this item in the FollowMe sequence.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.CallControl.CallingFeatures.Set.{i}.Voice2Mail." access="readOnly" minEntries="1" maxEntries="1" version="2.0">
|
||
<description>
|
||
Voice to mail specific attributes. Applies only if {{param|#.VoiceMailEnable}} is set to {{true}}.
|
||
</description>
|
||
<parameter name="Enable" access="readWrite" version="2.0">
|
||
<description>
|
||
Enable or disable voice mail notification.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="MaxMessageLength" access="readWrite" version="2.0">
|
||
<description>
|
||
Defines the maximum amount of time in {{units}} 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.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<units value="seconds"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Attach" access="readWrite" version="2.0">
|
||
<description>
|
||
Indicates if the message is sent as an attachment in voice mail notification.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="KeepLocal" access="readWrite" version="2.0">
|
||
<description>
|
||
Whether the voice to mail message is kept on the CPE after sending the mail. Applicable only if {{param|Attach}} is {{true}}.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="EMailAddress" access="readWrite" version="2.0">
|
||
<description>
|
||
E-mail for voice to mail notification messages.
|
||
</description>
|
||
<syntax>
|
||
<string/>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.Interwork.{i}." access="readWrite" numEntriesParameter="InterworkNumberOfEntries" enableParameter="Enable" minEntries="0" maxEntries="unbounded" version="2.0">
|
||
<description>
|
||
Each entry in this table configures Inter-Working Function switching features.
|
||
It is mutually exclusive with the {{object|.CallControl}} object which is used in case of PBX or Endpoint capabilities.
|
||
</description>
|
||
<uniqueKey functional="false">
|
||
<parameter ref="Alias"/>
|
||
</uniqueKey>
|
||
<parameter name="Enable" access="readWrite" version="2.0">
|
||
<description>
|
||
Enable or disable this {{object}} instance.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
<default type="object" value="false"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="QuiescentMode" access="readWrite" version="2.0">
|
||
<description>
|
||
If {{true}}, when {{param|Enable}} is set to {{false}} in-progress sessions remain intact, but no new sessions are allowed. When all sessions are terminated, the {{object}} is disabled.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Status" access="readOnly" version="2.0">
|
||
<description>
|
||
Indicates the status of this {{object}} instance.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="Up" version="2.0"/>
|
||
<enumeration value="Error" version="2.0"/>
|
||
<enumeration value="Quiescent" version="2.0"/>
|
||
<enumeration value="Disabled" version="2.0"/>
|
||
</string>
|
||
<default type="object" value="Disabled"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Alias" access="readWrite" activeNotify="canDeny" version="2.0">
|
||
<description>
|
||
{{datatype|expand}}
|
||
</description>
|
||
<syntax>
|
||
<dataType ref="Alias"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="OperationalStatus" access="readOnly" version="2.0">
|
||
<description>
|
||
Indicates the operational status of the {{object}} connections when {{param|Status}} is {{enum|Up|Status}}. {{enum}}
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="InService" version="2.0">
|
||
<description>
|
||
Indicates the {{object}} is operational.
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="OutOfService" version="2.0">
|
||
<description>
|
||
Indicates the {{object}} is not operational.
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="NetworkServersOffline" version="2.0">
|
||
<description>
|
||
Indicates the {{object}} has lost connection to all of the Network servers.
|
||
</description>
|
||
</enumeration>
|
||
</string>
|
||
<default type="object" value="OutOfService"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="OperationalStatusReason" access="readOnly" version="2.0">
|
||
<description>
|
||
Human-readable string identifying the reason or explanation for the current {{param|OperationalStatus}}.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="256"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="NetworkConnectionMode" access="readWrite" version="2.0">
|
||
<description>
|
||
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. {{enum}}
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="Static" version="2.0">
|
||
<description>
|
||
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
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="RegisterDynamic" version="2.0">
|
||
<description>
|
||
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
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="RegisterLearn" version="2.0">
|
||
<description>
|
||
The CPE registers toward the service provider network. The CPE creates the Client object and dynamically assigns its signaling address
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="RegisterStatic" version="2.0">
|
||
<description>
|
||
The CPE registers toward the service provider network. The ACS creates the Client object and statically provisions the Client parameters, including the signaling address
|
||
</description>
|
||
</enumeration>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="UserConnectionMode" access="readWrite" version="2.0">
|
||
<description>
|
||
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. {{enum}}
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="Static" version="2.0">
|
||
<description>
|
||
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
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="RegisterDynamic" version="2.0">
|
||
<description>
|
||
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
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="RegisterLearn" version="2.0">
|
||
<description>
|
||
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
|
||
</description>
|
||
</enumeration>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="E164Mode" access="readWrite" version="2.0">
|
||
<description>
|
||
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.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="NetworkAuthenticationChallengeMode" access="readWrite" version="2.0">
|
||
<description>
|
||
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). {{enum}}
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="PassThru" version="2.0">
|
||
<description>
|
||
The CPE transparently passes authentication challenges and challenge responses between the service provider network and the external user device
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="RespondLocal" version="2.0">
|
||
<description>
|
||
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
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="Hop-by-Hop" version="2.0">
|
||
<description>
|
||
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
|
||
</description>
|
||
</enumeration>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="NetworkIPAddress" access="readOnly" version="2.0">
|
||
<description>
|
||
The network IP Address of the CPE. The CPE MUST resolve this when the {{object|.Interwork.{i}.}} object is created.
|
||
Note: In case of multiple network IP addresses, the choice is left to the CPE.
|
||
</description>
|
||
<syntax>
|
||
<dataType ref="IPAddress"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="InterworkingRuleSetURI" access="readWrite" version="2.0">
|
||
<description>
|
||
URI of the Interworking Rule Set for this {{object}} instance.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="256"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="InterworkingRuleSetInterval" access="readWrite" version="2.0">
|
||
<description>
|
||
The duration in {{units}} 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.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<units value="seconds"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="InterworkingRuleSetTime" access="readWrite" version="2.0">
|
||
<description>
|
||
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 {{param|InterworkingRuleSetInterval}}.
|
||
{{param}} is used only to set the ''phase'' of refresh requests. The actual value of {{param}} can be arbitrarily far into the past or future.
|
||
For example, if {{param|InterworkingRuleSetInterval}} is 86400 (a day) and if {{param}} 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 {{param}} refers to a day in the future.
|
||
The Unknown Time value defined in {{bibref|TR-106a2|section 3.2}} 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 {{param|InterworkingRuleSetInterval}}.
|
||
If absolute time is not available to the CPE, its behavior MUST be the same as if the {{param}} parameter was set to the Unknown Time value.
|
||
</description>
|
||
<syntax>
|
||
<dateTime/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="FirewallRuleSetURI" access="readWrite" version="2.0">
|
||
<description>
|
||
URI of the Firewall Rule Set for this {{object}} instance.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="256"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="FirewallRuleSetInterval" access="readWrite" version="2.0">
|
||
<description>
|
||
The duration in {{units}} 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.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<units value="seconds"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="FirewallRuleSetTime" access="readWrite" version="2.0">
|
||
<description>
|
||
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 {{param|FirewallRuleSetInterval}}.
|
||
{{param}} is used only to set the ''phase'' of refresh requests. The actual value of {{param}} can be arbitrarily far into the past or future.
|
||
For example, if {{param|FirewallRuleSetInterval}} is 86400 (a day) and if {{param}} 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 {{param}} refers to a day in the future.
|
||
The Unknown Time value defined in {{bibref|TR-106a2|section 3.2}} 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 {{param|FirewallRuleSetInterval}}.
|
||
If absolute time is not available to the CPE, its behavior MUST be the same as if the {{param}} parameter was set to the Unknown Time value.
|
||
</description>
|
||
<syntax>
|
||
<dateTime/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="InterworkName" access="readWrite" version="2.0">
|
||
<description>
|
||
Human-readable string identifying the name or explanation for this {{object}}.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="256"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="ProxyServer" access="readWrite" version="2.0">
|
||
<description>
|
||
Reference to the {{object|.SIP.Proxy}} associated with this {{object}}. {{reference}}
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="256"/>
|
||
<pathRef refType="strong" targetParent=".SIP.Proxy." targetType="row"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Networks" access="readWrite" version="2.0">
|
||
<description>
|
||
{{list}} {{reference}}
|
||
List of available Networks for routing calls.
|
||
</description>
|
||
<syntax>
|
||
<list/>
|
||
<string>
|
||
<pathRef refType="strong" targetParent=".SIP.Network." targetType="row"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="E164Client" access="readWrite" version="2.0">
|
||
<description>
|
||
This parameter is MUST contain the {{object|.SIP.Client}} for all {{object|.Trunk}} objects referenced in the {{object|Map}} table when {{param|E164Mode}} = {{true}}.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="256"/>
|
||
<pathRef refType="strong" targetParent=".SIP.Client." targetType="row"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="UserInterfaceNumberOfEntries" access="readOnly" version="2.0">
|
||
<description>
|
||
{{numentries}}
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="MapNumberOfEntries" access="readOnly" version="2.0">
|
||
<description>
|
||
{{numentries}}
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.Interwork.{i}.UserInterface.{i}." access="readWrite" numEntriesParameter="UserInterfaceNumberOfEntries" enableParameter="Enable" minEntries="0" maxEntries="unbounded" version="2.0">
|
||
<description>
|
||
Each table entry references a row in the {{object|.SIP.Registrar}} table to identify the User IP address and listening port for the Device and the Network to route calls to.
|
||
</description>
|
||
<uniqueKey functional="false">
|
||
<parameter ref="Alias"/>
|
||
</uniqueKey>
|
||
<uniqueKey>
|
||
<parameter ref="Registrar"/>
|
||
</uniqueKey>
|
||
<parameter name="Enable" access="readWrite" version="2.0">
|
||
<description>
|
||
Enable ({{true}}) or disable ({{false}}) {{object}}.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
<default type="object" value="false"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Alias" access="readWrite" activeNotify="canDeny" version="2.0">
|
||
<description>
|
||
{{datatype|expand}}
|
||
</description>
|
||
<syntax>
|
||
<dataType ref="Alias"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Registrar" access="readWrite" version="2.0">
|
||
<description>
|
||
The {{object|.SIP.Registrar}} to use with this {{object|#}}. The value of {{param}} MUST be unique over all {{object|.Interwork.{i}.}}.
|
||
{{reference}}
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="256"/>
|
||
<pathRef refType="strong" targetParent=".SIP.Registrar." targetType="row"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Network" access="readWrite" version="2.0">
|
||
<description>
|
||
If not null this provides the appropriate {{object|.SIP.Network}} to route calls from this User server to.
|
||
{{reference}}
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="256"/>
|
||
<pathRef refType="strong" targetParent=".SIP.Network." targetType="row"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.Interwork.{i}.Map.{i}." access="readWrite" numEntriesParameter="MapNumberOfEntries" minEntries="0" maxEntries="unbounded" version="2.0">
|
||
<description>
|
||
For interworking use cases such as SIP-ISDN PBX plug and ESBC : mapping instance between a Network interface and a User extension.
|
||
</description>
|
||
<uniqueKey functional="false">
|
||
<parameter ref="Alias"/>
|
||
</uniqueKey>
|
||
<parameter name="Enable" access="readWrite" version="2.0">
|
||
<description>
|
||
Enable ({{true}}) or disable ({{false}}) this connection mapping.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
<default type="object" value="false"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Status" access="readOnly" version="2.0">
|
||
<description>
|
||
Indicates the status of this connection mapping. {{enum}}
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="Active" version="2.0">
|
||
<description>
|
||
indicates the {{object}} is valid
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="InActive" version="2.0">
|
||
<description>
|
||
indicates the {{object}} is valid but either the Network or User connection is not operational
|
||
</description>
|
||
</enumeration>
|
||
</string>
|
||
<default type="object" value="InActive"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Alias" access="readWrite" activeNotify="canDeny" version="2.0">
|
||
<description>
|
||
{{datatype|expand}}
|
||
</description>
|
||
<syntax>
|
||
<dataType ref="Alias"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="StatusDescription" access="readOnly" version="2.0">
|
||
<description>
|
||
Human-readable string identifying the reason or explanation of the current mapping {{param|Status}}.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="256"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="LastTime" access="readOnly" version="2.0">
|
||
<description>
|
||
The last time the Status was updated.
|
||
</description>
|
||
<syntax>
|
||
<dateTime/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Origin" access="readOnly" version="2.0">
|
||
<description>
|
||
Mechanism via which this connection mapping was assigned. {{enum}}
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="AutoConfigured" version="2.0">
|
||
<description>
|
||
Automatically generated, for example by a ESBC that auto-creates User and Network connections
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="Static" version="2.0">
|
||
<description>
|
||
For example, present in the factory default configuration, created by the ACS, or created by some other management entity (e.g. via a GUI).
|
||
</description>
|
||
</enumeration>
|
||
</string>
|
||
<default type="object" value="Static"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="NetworkConnection" access="readWrite" version="2.0">
|
||
<description>
|
||
{{reference}}. This parameter can only be modified if {{param|Origin}} is {{enum|Static|Origin}}.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="256"/>
|
||
<pathRef refType="strong" targetParent=".Trunk. .SIP.Client. .MGCP.Client. .H323.Client. .POTS.FXO." targetType="row"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="UserConnection" access="readWrite" version="2.0">
|
||
<description>
|
||
{{reference}}. This parameter can only be modified if {{param|Origin}} is {{enum|Static|Origin}}.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="256"/>
|
||
<pathRef refType="strong" targetParent=".Trunk. .ISDN.BRI. .ISDN.PRI. .SIP.Registrar.{i}.Account. .POTS.FXS. .DECT.Portable. .DECT.Base. .Terminal." targetType="row"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="DigitMap" access="readWrite" version="2.0">
|
||
<description>
|
||
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 {{bibref|RFC3435|Section 2.1.5}}.
|
||
This parameter is applicable only if the User interface supports per digit dialing and the Network interface supports en-bloc dialing only.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="256"/>
|
||
</string>
|
||
<default type="object" value=""/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="DigitMapEnable" access="readWrite" version="2.0">
|
||
<description>
|
||
Enables use of {{param|DigitMap}}.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
<default type="object" value="true"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Priority" access="readWrite" version="2.0">
|
||
<description>
|
||
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.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<range minInclusive="1"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.CallLog.{i}." access="readOnly" numEntriesParameter="CallLogNumberOfEntries" minEntries="0" maxEntries="unbounded" version="2.0">
|
||
<description>
|
||
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|.CallLog}} exceeds {{param|.Capabilities.MaxCallLogCount}}, the CPE SHOULD remove the oldest {{object|.CallLog}} object on basis of {{param|Start}} parameter.
|
||
</description>
|
||
<uniqueKey functional="false">
|
||
<parameter ref="Alias"/>
|
||
</uniqueKey>
|
||
<parameter name="Alias" access="readWrite" activeNotify="canDeny" version="2.0">
|
||
<description>
|
||
{{datatype|expand}}
|
||
</description>
|
||
<syntax>
|
||
<dataType ref="Alias"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="CallingPartyNumber" access="readOnly" version="2.0">
|
||
<description>
|
||
Number of the party originating the call.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="256"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="CalledPartyNumber" access="readOnly" version="2.0">
|
||
<description>
|
||
Number of destination party of the call.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="256"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Source" access="readOnly" version="2.0">
|
||
<description>
|
||
Party originating the call.
|
||
{{reference}}
|
||
{{object|.Trunk}}, {{object|.SIP.Registrar.{i}.Account}} and {{object|.SIP.Client}} objects SHOULD be referenced only when {{object|.Interwork}} is in use.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="256"/>
|
||
<pathRef refType="strong" targetParent=".CallControl.Line. .CallControl.Extension. .SIP.Registrar.{i}.Account. .Trunk. .SIP.Client." targetType="row"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Destination" access="readOnly" version="2.0">
|
||
<description>
|
||
Destination party of the call.
|
||
{{reference}}
|
||
{{object|.Trunk}}, {{object|.SIP.Registrar.{i}.Account}} and {{object|.SIP.Client}} objects SHOULD be only referenced only when {{object|.Interwork}} is in use.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="256"/>
|
||
<pathRef refType="strong" targetParent=".CallControl.Line. .CallControl.Extension. .SIP.Registrar.{i}.Account. .Trunk. .SIP.Client." targetType="row"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="RemoteParty" access="readOnly" version="2.0">
|
||
<description>
|
||
The phone number of the remote party after the dial plan has been processed.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="32"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="UsedLine" access="readOnly" version="2.0">
|
||
<description>
|
||
The {{object|.CallControl.Line}} used to process the call.
|
||
{{reference}}
|
||
When {{object|.Interwork}} is in use, this parameter is {{empty}}.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="256"/>
|
||
<pathRef refType="strong" targetParent=".CallControl.Line." targetType="row"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="UsedExtensions" access="readOnly" version="2.0">
|
||
<description>
|
||
{{list}} {{reference}}
|
||
For an incoming call multiple {{object|.CallControl.Extension}} objects can be involved till one user answers the call.
|
||
When {{object|.Interwork}} is in use, this parameter is {{empty}}.
|
||
</description>
|
||
<syntax>
|
||
<list/>
|
||
<string>
|
||
<pathRef refType="strong" targetParent=".CallControl.Extension." targetType="row"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Direction" access="readOnly" version="2.0">
|
||
<description>
|
||
Direction of the call.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="Incoming" version="2.0"/>
|
||
<enumeration value="Outgoing" version="2.0"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Start" access="readOnly" version="2.0">
|
||
<description>
|
||
Start of the call.
|
||
</description>
|
||
<syntax>
|
||
<dateTime/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Duration" access="readOnly" version="2.0">
|
||
<description>
|
||
Length of the call in {{units}}.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<units value="seconds"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="CallTerminationCause" access="readOnly" version="2.0">
|
||
<description>
|
||
The call termination cause.
|
||
The parameter MAY instead indicate a vendor-specific cause, which MUST use the format defined in {{bibref|TR-106}}.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="NoExtensionsMapped" version="2.0"/>
|
||
<enumeration value="NoExtensionsAvailable" version="2.0"/>
|
||
<enumeration value="AnonymousCallRejection" version="2.0"/>
|
||
<enumeration value="CallWaitingRejected" version="2.0"/>
|
||
<enumeration value="CallForwardingUnconditional" version="2.0"/>
|
||
<enumeration value="CallForwardingBusy" version="2.0"/>
|
||
<enumeration value="CallForwardingNoReply" version="2.0"/>
|
||
<enumeration value="LocalDisconnect" version="2.0"/>
|
||
<enumeration value="LocalForbidden" version="2.0"/>
|
||
<enumeration value="LocalTimeout" version="2.0"/>
|
||
<enumeration value="LocalMediaError." version="2.0"/>
|
||
<enumeration value="LocalPriority." version="2.0"/>
|
||
<enumeration value="LocalReject" version="2.0"/>
|
||
<enumeration value="LocalTransfer" version="2.0"/>
|
||
<enumeration value="LocalInternalError" version="2.0"/>
|
||
<enumeration value="RemoteDisconnect" version="2.0"/>
|
||
<enumeration value="RemoteBadRequest" version="2.0"/>
|
||
<enumeration value="RemoteForbidden" version="2.0"/>
|
||
<enumeration value="RemoteNotFound" version="2.0"/>
|
||
<enumeration value="RemoteReject" version="2.0"/>
|
||
<enumeration value="RemoteNotAllowed" version="2.0"/>
|
||
<enumeration value="RemoteNotAcceptable" version="2.0"/>
|
||
<enumeration value="RemoteTimeout" version="2.0"/>
|
||
<enumeration value="RemoteUnavailable" version="2.0"/>
|
||
<enumeration value="RemoteBusy" version="2.0"/>
|
||
<enumeration value="RemoteNotSupported" version="2.0"/>
|
||
<enumeration value="RemoteNetworkFailure" version="2.0"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="SessionNumberOfEntries" access="readOnly" version="2.0">
|
||
<description>
|
||
Indicates the number of entries in {{object|.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.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="SignalingPerformanceNumberOfEntries" access="readOnly" version="2.0">
|
||
<description>
|
||
{{numentries}}
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.CallLog.{i}.SignalingPerformance.{i}." access="readOnly" numEntriesParameter="SignalingPerformanceNumberOfEntries" minEntries="1" maxEntries="unbounded" version="2.0">
|
||
<description>
|
||
This table contains signaling performance statistics for each protocol involved in the call.
|
||
</description>
|
||
<uniqueKey>
|
||
<parameter ref="Protocol"/>
|
||
</uniqueKey>
|
||
<parameter name="Protocol" access="readOnly" version="2.0">
|
||
<description>
|
||
Protocol for which this signaling performance statistics are available.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="H.323" version="2.0"/>
|
||
<enumeration value="SIP" version="2.0"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="CallSetupDelay" access="readOnly" version="2.0">
|
||
<description>
|
||
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 {{units}}.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<units value="milliseconds"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="OutgoingMediaEstablishDelay" access="readOnly" version="2.0">
|
||
<description>
|
||
The time in {{units}} 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.
|
||
</description>
|
||
<syntax>
|
||
<int>
|
||
<units value="milliseconds"/>
|
||
</int>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="IncomingMediaEstablishDelay" access="readOnly" version="2.0">
|
||
<description>
|
||
The time in {{units}} 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.
|
||
</description>
|
||
<syntax>
|
||
<int>
|
||
<units value="milliseconds"/>
|
||
</int>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.CallLog.{i}.Session.{i}." access="readOnly" numEntriesParameter="SessionNumberOfEntries" minEntries="0" maxEntries="unbounded" version="2.0">
|
||
<description>
|
||
Session information within one call.
|
||
</description>
|
||
<uniqueKey>
|
||
<parameter ref="SessionID"/>
|
||
</uniqueKey>
|
||
<parameter name="StreamType" access="readOnly" version="2.0">
|
||
<description>
|
||
The type of media stream used in this session.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="Audio" version="2.0"/>
|
||
<enumeration value="Video" version="2.0"/>
|
||
<enumeration value="Fax" version="2.0"/>
|
||
<enumeration value="Modem" version="2.0"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Start" access="readOnly" version="2.0">
|
||
<description>
|
||
The time that the session started, in UTC.
|
||
</description>
|
||
<syntax>
|
||
<dateTime/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Duration" access="readOnly" version="2.0">
|
||
<description>
|
||
Length of the session in {{units}}.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<units value="seconds"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="SessionID" access="readOnly" version="2.0">
|
||
<description>
|
||
Session Identifier. For the SIP protocol this corresponds to the SIP SDP session identifier.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="16"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="SIPSessionID" access="readOnly" version="2.0">
|
||
<description>
|
||
SIP Session Identifier
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="32"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.CallLog.{i}.Session.{i}.Source." access="readOnly" minEntries="1" maxEntries="1" version="2.0">
|
||
<description>
|
||
The source of the session information within one call.
|
||
</description>
|
||
</object>
|
||
<object name="VoiceService.{i}.CallLog.{i}.Session.{i}.Source.RTP." access="readOnly" minEntries="1" maxEntries="1" version="2.0">
|
||
<description>
|
||
The RTP part of the source session information.
|
||
</description>
|
||
<parameter name="FarEndIPAddress" access="readOnly" version="2.0">
|
||
<description>
|
||
The IP address of far end VoIP device.
|
||
</description>
|
||
<syntax>
|
||
<dataType ref="IPAddress"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="FarEndUDPPort" access="readOnly" version="2.0">
|
||
<description>
|
||
The UDP port used for current session in the far end device.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<range minInclusive="0" maxInclusive="65535"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="LocalUDPPort" access="readOnly" version="2.0">
|
||
<description>
|
||
The local UDP port used for current session.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<range minInclusive="0" maxInclusive="65535"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="MinJitter" access="readOnly" version="2.0">
|
||
<description>
|
||
The minimum relative transit time in {{units}} between two packets as defined in {{bibref|RFC3611}}.
|
||
A value of -1 indicates no reliable value is available.
|
||
</description>
|
||
<syntax>
|
||
<int>
|
||
<range minInclusive="-1"/>
|
||
<units value="milliseconds"/>
|
||
</int>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="MaxJitter" access="readOnly" version="2.0">
|
||
<description>
|
||
The maximum relative transit time in {{units}} between two packets as defined in {{bibref|RFC3611}}.
|
||
A value of -1 indicates no reliable value is available.
|
||
</description>
|
||
<syntax>
|
||
<int>
|
||
<range minInclusive="-1"/>
|
||
<units value="milliseconds"/>
|
||
</int>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="MeanJitter" access="readOnly" version="2.0">
|
||
<description>
|
||
The mean relative transit time in {{units}} between each two packet series as defined in {{bibref|RFC3611}}.
|
||
A value of -1 indicates no reliable value is available.
|
||
</description>
|
||
<syntax>
|
||
<int>
|
||
<range minInclusive="-1"/>
|
||
<units value="milliseconds"/>
|
||
</int>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="PacketDelayVariation" access="readOnly" version="2.0">
|
||
<description>
|
||
1-Point Packet Delay Variation according to {{bibref|Y.1540}} in {{units}}.
|
||
A value of -1 indicates no reliable value is available.
|
||
</description>
|
||
<syntax>
|
||
<int>
|
||
<range minInclusive="-1"/>
|
||
<units value="milliseconds"/>
|
||
</int>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="BufferDelay" access="readOnly" version="2.0">
|
||
<description>
|
||
Average delay in {{units}} added by buffer processing.
|
||
A value of -1 indicates no reliable value is available.
|
||
</description>
|
||
<syntax>
|
||
<int>
|
||
<range minInclusive="-1"/>
|
||
<units value="microseconds"/>
|
||
</int>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="BurstCount" access="readOnly" version="2.0">
|
||
<description>
|
||
The number of bursts (as defined in {{bibref|RFC3611}}) that occur during this session (during one burst several packets MAY be lost).
|
||
The burst's threshold is configured with the parameter {{param|.VoIPProfile.{i}.RTP.Gmin}}.
|
||
</description>
|
||
<syntax>
|
||
<dataType ref="StatsCounter32"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="PacketsReceived" access="readOnly" version="2.0">
|
||
<description>
|
||
Total number of RTP packets received for this session.
|
||
</description>
|
||
<syntax>
|
||
<dataType ref="StatsCounter64"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="PacketsSent" access="readOnly" version="2.0">
|
||
<description>
|
||
Total number of RTP packets sent for this session.
|
||
</description>
|
||
<syntax>
|
||
<dataType ref="StatsCounter64"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="PacketsLost" access="readOnly" version="2.0">
|
||
<description>
|
||
Total number of RTP packets that have been lost for this session (see {{bibref|RFC3611}}).
|
||
</description>
|
||
<syntax>
|
||
<dataType ref="StatsCounter32"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="PacketsDiscarded" access="readOnly" version="2.0">
|
||
<description>
|
||
Total number of RTP packets that have been discarded for this session (see {{bibref|RFC3611}}).
|
||
</description>
|
||
<syntax>
|
||
<dataType ref="StatsCounter32"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="BytesReceived" access="readOnly" version="2.0">
|
||
<description>
|
||
Total number of bytes received for this session.
|
||
</description>
|
||
<syntax>
|
||
<dataType ref="StatsCounter64"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="BytesSent" access="readOnly" version="2.0">
|
||
<description>
|
||
Total number of bytes sent for this session.
|
||
</description>
|
||
<syntax>
|
||
<dataType ref="StatsCounter64"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="ReceivePacketLossRate" access="readOnly" activeNotify="canDeny" version="2.0">
|
||
<description>
|
||
Current receive packet loss rate in percent, calculated as defined in {{bibref|RFC3550|Section 6.4}}.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<range minInclusive="0" maxInclusive="100"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="FarEndPacketLossRate" access="readOnly" activeNotify="canDeny" version="2.0">
|
||
<description>
|
||
Current far end receive packet lost rate in percent, calculated as defined in {{bibref|RFC3550|Section 6.4}}.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<range minInclusive="0" maxInclusive="100"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="ReceiveInterarrivalJitter" access="readOnly" activeNotify="canDeny" version="2.0">
|
||
<description>
|
||
Current receive interarrival jitter in timestamp units. Calculated from J(i) as defined in {{bibref|RFC3550|Section 6.4}}.
|
||
A value of -1 indicates no reliable value is available.
|
||
</description>
|
||
<syntax>
|
||
<int>
|
||
<range minInclusive="-1"/>
|
||
</int>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="FarEndInterarrivalJitter" access="readOnly" activeNotify="canDeny" version="2.0">
|
||
<description>
|
||
Current Interarrival jitter in timestamp units as reported from the far-end device via RTCP. Calculated from J(i) as defined in {{bibref|RFC3550|Section 6.4}}.
|
||
A value of -1 indicates no reliable value is available.
|
||
</description>
|
||
<syntax>
|
||
<int>
|
||
<range minInclusive="-1"/>
|
||
</int>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="AverageReceiveInterarrivalJitter" access="readOnly" activeNotify="canDeny" version="2.0">
|
||
<description>
|
||
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.
|
||
</description>
|
||
<syntax>
|
||
<int>
|
||
<range minInclusive="-1"/>
|
||
</int>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="AverageFarEndInterarrivalJitter" access="readOnly" activeNotify="canDeny" version="2.0">
|
||
<description>
|
||
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.
|
||
</description>
|
||
<syntax>
|
||
<int>
|
||
<range minInclusive="-1"/>
|
||
</int>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="RoundTripDelay" access="readOnly" activeNotify="canDeny" version="2.0">
|
||
<description>
|
||
Current round trip delay in {{units}} calculated as defined in {{bibref|RFC3550|Section 6.4}}.
|
||
A value of -1 indicates no reliable value is available.
|
||
</description>
|
||
<syntax>
|
||
<int>
|
||
<range minInclusive="-1"/>
|
||
<units value="microseconds"/>
|
||
</int>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="AverageRoundTripDelay" access="readOnly" activeNotify="canDeny" version="2.0">
|
||
<description>
|
||
Average round trip delay in {{units}} since the beginning of the current session.
|
||
A value of -1 indicates no reliable value is available.
|
||
</description>
|
||
<syntax>
|
||
<int>
|
||
<range minInclusive="-1"/>
|
||
<units value="microseconds"/>
|
||
</int>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="SamplingFrequency" access="readOnly" activeNotify="canDeny" version="2.0">
|
||
<description>
|
||
Sample frequency in {{units}} used by the codec for this session.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<units value="Hertz"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.CallLog.{i}.Session.{i}.Source.DSP." access="readOnly" minEntries="1" maxEntries="1" version="2.0">
|
||
<description>
|
||
The DSP part of the line session information.
|
||
</description>
|
||
</object>
|
||
<object name="VoiceService.{i}.CallLog.{i}.Session.{i}.Source.DSP.ReceiveCodec." access="readOnly" minEntries="1" maxEntries="1" version="2.0">
|
||
<description>
|
||
The receive codec used in this session.
|
||
</description>
|
||
<parameter name="Codec" access="readOnly" version="2.0">
|
||
<description>
|
||
The codec in use for the incoming voice stream.
|
||
{{reference}}
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="256"/>
|
||
<pathRef refType="strong" targetParent=".Capabilities.Codec." targetType="row"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="SilenceSuppression" access="readOnly" version="2.0">
|
||
<description>
|
||
Whether or not silence suppression is in use for the incoming voice stream.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Overruns" access="readOnly" version="2.0">
|
||
<description>
|
||
Total number of times the receive jitter buffer has overrun for this session.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Underruns" access="readOnly" version="2.0">
|
||
<description>
|
||
Total number of times the receive jitter buffer has underrun for this session.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.CallLog.{i}.Session.{i}.Source.DSP.TransmitCodec." access="readOnly" minEntries="1" maxEntries="1" version="2.0">
|
||
<description>
|
||
The transmit codec used in this session.
|
||
</description>
|
||
<parameter name="Codec" access="readOnly" version="2.0">
|
||
<description>
|
||
The codec in use for the outgoing voice stream.
|
||
{{reference}}
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="256"/>
|
||
<pathRef refType="strong" targetParent=".Capabilities.Codec." targetType="row"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="SilenceSuppression" access="readOnly" version="2.0">
|
||
<description>
|
||
Whether or not silence suppression is in use for the outgoing voice stream.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="PacketizationPeriod" access="readOnly" version="2.0">
|
||
<description>
|
||
Current outgoing packetization period in {{units}}.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<units value="milliseconds"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Overruns" access="readOnly" version="2.0">
|
||
<description>
|
||
Total number of times the transmit jitter buffer has overrun for this session.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Underruns" access="readOnly" version="2.0">
|
||
<description>
|
||
Total number of times the transmit jitter buffer has underrun for this session.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.CallLog.{i}.Session.{i}.Source.VoiceQuality." access="readOnly" minEntries="1" maxEntries="1" version="2.0">
|
||
<description>
|
||
VoIP Statistics for current session instance.
|
||
</description>
|
||
<parameter name="VoIPQualityIndicator" access="readOnly" version="2.0">
|
||
<description>
|
||
{{list|representing the VoIP quality calculated for consecutive intervals of the session}} The interval is specified by {{param|.VoIPProfile.{i}.QICalculationInterval}} and the quality model used is specified by {{param|.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 {{param|.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 {{param}} is reported as "78,57,88,79,34,56", and {{param|.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 {{param|.VoIPProfile.{i}.QICalculationInterval}}, but the length can be deduced using {{param|##.Duration}}.
|
||
</description>
|
||
<syntax>
|
||
<list/>
|
||
<unsignedInt>
|
||
<range maxInclusive="65535"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="WorstVoIPQualityIndicatorsValues" access="readOnly" version="2.0">
|
||
<description>
|
||
{{list|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 {{param|.VoIPProfile.{i}.NumberOfWorstQIValues}} attribute.
|
||
The values are given in the same algorithm-specific representation as {{param|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.
|
||
</description>
|
||
<syntax>
|
||
<list/>
|
||
<unsignedInt>
|
||
<range maxInclusive="65535"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="WorstVoIPQualityIndicatorTimestamps" access="readOnly" version="2.0">
|
||
<description>
|
||
{{list}} Each value represents the timestamp index, given in units of {{param|.VoIPProfile.{i}.QICalculationInterval}}, when the corresponding value in {{param|WorstVoIPQualityIndicatorsValues}} was calculated.
|
||
The first index is number 1.
|
||
Only the N worst values are stored, where N is the limit stored in {{param|.VoIPProfile.{i}.NumberOfWorstQIValues}}.
|
||
Example: if {{param|.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.
|
||
</description>
|
||
<syntax>
|
||
<list/>
|
||
<unsignedInt>
|
||
<range maxInclusive="65535"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.CallLog.{i}.Session.{i}.Destination." access="readOnly" minEntries="1" maxEntries="1" version="2.0">
|
||
<description>
|
||
The destination part of session information within one call.
|
||
</description>
|
||
</object>
|
||
<object name="VoiceService.{i}.CallLog.{i}.Session.{i}.Destination.RTP." access="readOnly" minEntries="1" maxEntries="1" version="2.0">
|
||
<description>
|
||
The RTP part of the destination session information.
|
||
</description>
|
||
<parameter name="FarEndIPAddress" access="readOnly" version="2.0">
|
||
<description>
|
||
The IP address of far end VoIP device.
|
||
</description>
|
||
<syntax>
|
||
<dataType ref="IPAddress"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="FarEndUDPPort" access="readOnly" version="2.0">
|
||
<description>
|
||
The UDP port used for current session in the far end device.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<range minInclusive="0" maxInclusive="65535"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="LocalUDPPort" access="readOnly" version="2.0">
|
||
<description>
|
||
The local UDP port used for current session.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<range minInclusive="0" maxInclusive="65535"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="MinJitter" access="readOnly" version="2.0">
|
||
<description>
|
||
The minimum relative transit time in {{units}} between two packets as defined in {{bibref|RFC3611}}.
|
||
A value of -1 indicates no reliable value is available.
|
||
</description>
|
||
<syntax>
|
||
<int>
|
||
<range minInclusive="-1"/>
|
||
<units value="milliseconds"/>
|
||
</int>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="MaxJitter" access="readOnly" version="2.0">
|
||
<description>
|
||
The maximum relative transit time in {{units}} between two packets as defined in {{bibref|RFC3611}}.
|
||
A value of -1 indicates no reliable value is available.
|
||
</description>
|
||
<syntax>
|
||
<int>
|
||
<range minInclusive="-1"/>
|
||
<units value="milliseconds"/>
|
||
</int>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="MeanJitter" access="readOnly" version="2.0">
|
||
<description>
|
||
The mean relative transit time in {{units}} between each two packet series as defined in {{bibref|RFC3611}}.
|
||
A value of -1 indicates no reliable value is available.
|
||
</description>
|
||
<syntax>
|
||
<int>
|
||
<range minInclusive="-1"/>
|
||
<units value="milliseconds"/>
|
||
</int>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="PacketDelayVariation" access="readOnly" version="2.0">
|
||
<description>
|
||
1-Point Packet Delay Variation according to {{bibref|Y.1540}} in {{units}}.
|
||
A value of -1 indicates no reliable value is available.
|
||
</description>
|
||
<syntax>
|
||
<int>
|
||
<range minInclusive="-1"/>
|
||
<units value="milliseconds"/>
|
||
</int>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="BufferDelay" access="readOnly" version="2.0">
|
||
<description>
|
||
Average delay in {{units}} added by buffer processing.
|
||
A value of -1 indicates no reliable value is available.
|
||
</description>
|
||
<syntax>
|
||
<int>
|
||
<range minInclusive="-1"/>
|
||
<units value="microseconds"/>
|
||
</int>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="BurstCount" access="readOnly" version="2.0">
|
||
<description>
|
||
The number of bursts (as defined in {{bibref|RFC3611}}) that occur during this session (during one burst several packets MAY be lost).
|
||
The burst's threshold is configured with the parameter {{param|.VoIPProfile.{i}.RTP.Gmin}}.
|
||
</description>
|
||
<syntax>
|
||
<dataType ref="StatsCounter32"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="PacketsReceived" access="readOnly" version="2.0">
|
||
<description>
|
||
Total number of RTP packets received for this session.
|
||
</description>
|
||
<syntax>
|
||
<dataType ref="StatsCounter64"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="PacketsSent" access="readOnly" version="2.0">
|
||
<description>
|
||
Total number of RTP packets sent for this session.
|
||
</description>
|
||
<syntax>
|
||
<dataType ref="StatsCounter64"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="PacketsLost" access="readOnly" version="2.0">
|
||
<description>
|
||
Total number of RTP packets that have been lost for this session (see {{bibref|RFC3611}}).
|
||
</description>
|
||
<syntax>
|
||
<dataType ref="StatsCounter32"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="PacketsDiscarded" access="readOnly" version="2.0">
|
||
<description>
|
||
Total number of RTP packets that have been discarded for this session (see {{bibref|RFC3611}}).
|
||
</description>
|
||
<syntax>
|
||
<dataType ref="StatsCounter32"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="BytesReceived" access="readOnly" version="2.0">
|
||
<description>
|
||
Total number of bytes received for this session.
|
||
</description>
|
||
<syntax>
|
||
<dataType ref="StatsCounter64"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="BytesSent" access="readOnly" version="2.0">
|
||
<description>
|
||
Total number of bytes sent for this session.
|
||
</description>
|
||
<syntax>
|
||
<dataType ref="StatsCounter64"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="ReceivePacketLossRate" access="readOnly" activeNotify="canDeny" version="2.0">
|
||
<description>
|
||
Current receive packet loss rate in percent, calculated as defined in {{bibref|RFC3550|Section 6.4}}.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<range minInclusive="0" maxInclusive="100"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="FarEndPacketLossRate" access="readOnly" activeNotify="canDeny" version="2.0">
|
||
<description>
|
||
Current far end receive packet lost rate in percent, calculated as defined in {{bibref|RFC3550|Section 6.4}}.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<range minInclusive="0" maxInclusive="100"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="ReceiveInterarrivalJitter" access="readOnly" activeNotify="canDeny" version="2.0">
|
||
<description>
|
||
Current receive interarrival jitter in timestamp units. Calculated from J(i) as defined in {{bibref|RFC3550|Section 6.4}}.
|
||
A value of -1 indicates no reliable value is available.
|
||
</description>
|
||
<syntax>
|
||
<int>
|
||
<range minInclusive="-1"/>
|
||
</int>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="FarEndInterarrivalJitter" access="readOnly" activeNotify="canDeny" version="2.0">
|
||
<description>
|
||
Current Interarrival jitter in timestamp units as reported from the far-end device via RTCP. Calculated from J(i) as defined in {{bibref|RFC3550|Section 6.4}}.
|
||
A value of -1 indicates no reliable value is available.
|
||
</description>
|
||
<syntax>
|
||
<int>
|
||
<range minInclusive="-1"/>
|
||
</int>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="AverageReceiveInterarrivalJitter" access="readOnly" activeNotify="canDeny" version="2.0">
|
||
<description>
|
||
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.
|
||
</description>
|
||
<syntax>
|
||
<int>
|
||
<range minInclusive="-1"/>
|
||
</int>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="AverageFarEndInterarrivalJitter" access="readOnly" activeNotify="canDeny" version="2.0">
|
||
<description>
|
||
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.
|
||
</description>
|
||
<syntax>
|
||
<int>
|
||
<range minInclusive="-1"/>
|
||
</int>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="RoundTripDelay" access="readOnly" activeNotify="canDeny" version="2.0">
|
||
<description>
|
||
Current round trip delay in {{units}} calculated as defined in {{bibref|RFC3550|Section 6.4}}.
|
||
A value of -1 indicates no reliable value is available.
|
||
</description>
|
||
<syntax>
|
||
<int>
|
||
<range minInclusive="-1"/>
|
||
<units value="microseconds"/>
|
||
</int>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="AverageRoundTripDelay" access="readOnly" activeNotify="canDeny" version="2.0">
|
||
<description>
|
||
Average round trip delay in {{units}} since the beginning of the current session.
|
||
A value of -1 indicates no reliable value is available.
|
||
</description>
|
||
<syntax>
|
||
<int>
|
||
<range minInclusive="-1"/>
|
||
<units value="microseconds"/>
|
||
</int>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="SamplingFrequency" access="readOnly" activeNotify="canDeny" version="2.0">
|
||
<description>
|
||
Sample frequency in {{units}} used by the codec for this session.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<units value="Hertz"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.CallLog.{i}.Session.{i}.Destination.DSP." access="readOnly" minEntries="1" maxEntries="1" version="2.0">
|
||
<description>
|
||
The DSP part of the destination session information.
|
||
</description>
|
||
</object>
|
||
<object name="VoiceService.{i}.CallLog.{i}.Session.{i}.Destination.DSP.ReceiveCodec." access="readOnly" minEntries="1" maxEntries="1" version="2.0">
|
||
<description>
|
||
The receive codec used in this session.
|
||
</description>
|
||
<parameter name="Codec" access="readOnly" version="2.0">
|
||
<description>
|
||
The codec in use for the incoming voice stream.
|
||
{{reference}}
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="256"/>
|
||
<pathRef refType="strong" targetParent=".Capabilities.Codec." targetType="row"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="SilenceSuppression" access="readOnly" version="2.0">
|
||
<description>
|
||
Whether or not silence suppression is in use for the incoming voice stream.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Overruns" access="readOnly" version="2.0">
|
||
<description>
|
||
Total number of times the receive jitter buffer has overrun for this session.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Underruns" access="readOnly" version="2.0">
|
||
<description>
|
||
Total number of times the receive jitter buffer has underrun for this session.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.CallLog.{i}.Session.{i}.Destination.DSP.TransmitCodec." access="readOnly" minEntries="1" maxEntries="1" version="2.0">
|
||
<description>
|
||
The transmit codec used in this session.
|
||
</description>
|
||
<parameter name="Codec" access="readOnly" version="2.0">
|
||
<description>
|
||
The codec in use for the outgoing voice stream.
|
||
{{reference}}
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="256"/>
|
||
<pathRef refType="strong" targetParent=".Capabilities.Codec." targetType="row"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="SilenceSuppression" access="readOnly" version="2.0">
|
||
<description>
|
||
Whether or not silence suppression is in use for the outgoing voice stream.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="PacketizationPeriod" access="readOnly" version="2.0">
|
||
<description>
|
||
Current outgoing packetization period in {{units}}.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<units value="milliseconds"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Overruns" access="readOnly" version="2.0">
|
||
<description>
|
||
Total number of times the transmit jitter buffer has overrun for this session.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Underruns" access="readOnly" version="2.0">
|
||
<description>
|
||
Total number of times the transmit jitter buffer has underrun for this session.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.CallLog.{i}.Session.{i}.Destination.VoiceQuality." access="readOnly" minEntries="1" maxEntries="1" version="2.0">
|
||
<description>
|
||
VoIP Statistics for current session instance.
|
||
</description>
|
||
<parameter name="VoIPQualityIndicator" access="readOnly" version="2.0">
|
||
<description>
|
||
{{list|representing the VoIP quality calculated for consecutive intervals of the session}} The interval is specified by {{param|.VoIPProfile.{i}.QICalculationInterval}} and the quality model used is specified by {{param|.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 {{param|.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 {{param}} is reported as "78,57,88,79,34,56", and {{param|.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 {{param|.VoIPProfile.{i}.QICalculationInterval}}, but the length can be deduced using {{param|##.Duration}}.
|
||
</description>
|
||
<syntax>
|
||
<list/>
|
||
<unsignedInt>
|
||
<range maxInclusive="65535"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="WorstVoIPQualityIndicatorsValues" access="readOnly" version="2.0">
|
||
<description>
|
||
{{list|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 {{param|.VoIPProfile.{i}.NumberOfWorstQIValues}} attribute.
|
||
The values are given in the same algorithm-specific representation as {{param|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.
|
||
</description>
|
||
<syntax>
|
||
<list/>
|
||
<unsignedInt>
|
||
<range maxInclusive="65535"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="WorstVoIPQualityIndicatorTimestamps" access="readOnly" version="2.0">
|
||
<description>
|
||
{{list}} Each value represents the timestamp index, given in units of {{param|.VoIPProfile.{i}.QICalculationInterval}}, when the corresponding value in {{param|WorstVoIPQualityIndicatorsValues}} was calculated.
|
||
The first index is number 1.
|
||
Only the N worst values are stored, where N is the limit stored in {{param|.VoIPProfile.{i}.NumberOfWorstQIValues}}.
|
||
Example: if {{param|.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.
|
||
</description>
|
||
<syntax>
|
||
<list/>
|
||
<unsignedInt>
|
||
<range maxInclusive="65535"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.VoIPProfile.{i}." access="readWrite" numEntriesParameter="VoIPProfileNumberOfEntries" enableParameter="Enable" minEntries="0" maxEntries="unbounded" version="2.0">
|
||
<description>
|
||
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 {{object|.SIP.Network.}}, {{object|.SIP.Proxy.}}, {{object|.SIP.Network.}}, {{object|.H323.Network.}} and {{object|.MGCP.Network.}}.
|
||
</description>
|
||
<uniqueKey functional="false">
|
||
<parameter ref="Alias"/>
|
||
</uniqueKey>
|
||
<parameter name="Enable" access="readWrite" version="2.0">
|
||
<description>
|
||
Enables or disables this VoIP profile. If the value is set to {{false}}, all components using the profile are disabled, whatever their status is.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
<default type="object" value="false"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="QuiescentMode" access="readWrite" version="2.0">
|
||
<description>
|
||
If {{true}}, when {{param|Enable}} is set to {{false}} in-progress sessions remain intact, but no new sessions are allowed. When all sessions are terminated, the {{object}} is disabled.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Name" access="readWrite" version="2.0">
|
||
<description>
|
||
Human-readable string to identify the profile instance.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="64"/>
|
||
</string>
|
||
<default type="object" value=""/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Alias" access="readWrite" activeNotify="canDeny" version="2.0">
|
||
<description>
|
||
{{datatype|expand}}
|
||
</description>
|
||
<syntax>
|
||
<dataType ref="Alias"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="DTMFMethod" access="readWrite" version="2.0">
|
||
<description>
|
||
{{list}} Method by which DTMF digits MUST be passed. {{enum}}
|
||
If {{param|DTMFMethodG711}} is non-empty, then this parameter applies only when the current codec is not G.711.
|
||
</description>
|
||
<syntax>
|
||
<list/>
|
||
<string>
|
||
<enumeration value="InBand" version="2.0"/>
|
||
<enumeration value="RFC4733" version="2.0"/>
|
||
<enumeration value="SIPInfo" version="2.0">
|
||
<description>
|
||
Applicable only for {{object|.SIP.Client.{i}.}}.
|
||
</description>
|
||
</enumeration>
|
||
</string>
|
||
<default type="object" value="InBand"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="DTMFMethodG711" access="readWrite" version="2.0">
|
||
<description>
|
||
Method by which DTMF digits MUST be passed if the the current codec is G.711. {{enum}}
|
||
If {{empty}} indicates that the value of {{param|DTMFMethod}} is to apply whether or not the the the current codec is G.711.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="InBand" version="2.0"/>
|
||
<enumeration value="RFC4733" version="2.0"/>
|
||
<enumeration value="SIPInfo" version="2.0">
|
||
<description>
|
||
Applicable only for {{object|.SIP.Client.{i}.}}.
|
||
</description>
|
||
</enumeration>
|
||
<enumeration value="" version="2.0"/>
|
||
</string>
|
||
<default type="object" value=""/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="QIModelUsed" access="readWrite" version="2.0">
|
||
<description>
|
||
Quality model which the CPE shall use to calculate the parameters {{param|.CallLog.{i}.Session.{i}.Source.VoiceQuality.VoIPQualityIndicator}} and {{param|.CallLog.{i}.Session.{i}.Destination.VoiceQuality.VoIPQualityIndicator}}. The value MUST be a member of the list reported by the {{param|.Capabilities.QualityIndicator.QIModelsSupported}} parameter.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="128"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="QICalculationInterval" access="readWrite" version="2.0">
|
||
<description>
|
||
The interval between successive calculations of {{param|.CallLog.{i}.Session.{i}.Source.VoiceQuality.VoIPQualityIndicator}} and {{param|.CallLog.{i}.Session.{i}.Destination.VoiceQuality.VoIPQualityIndicator}} values (in {{units}}). If {{param}} is not set then only one final quality value covering the complete session is reported in {{param|.CallLog.{i}.Session.{i}.Source.VoiceQuality.VoIPQualityIndicator}} and {{param|.CallLog.{i}.Session.{i}.Destination.VoiceQuality.VoIPQualityIndicator}}.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<units value="seconds"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="NumberOfWorstQIValues" access="readWrite" version="2.0">
|
||
<description>
|
||
The maximum number of worst quality indicators to store for each call.
|
||
The CPE MUST permit {{param}} to be set to any value in the range from 0 to {{param|.Capabilities.QualityIndicator.MaxWorstQIValues}}.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.VoIPProfile.{i}.RTP." access="readOnly" minEntries="1" maxEntries="1" version="2.0">
|
||
<description>
|
||
VoIP profile parameters related to the voice stream sent via RTP.
|
||
</description>
|
||
<parameter name="LocalPortMin" access="readWrite" version="2.0">
|
||
<description>
|
||
Base of port range to be used for incoming RTP streams for this profile.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<range minInclusive="1" maxInclusive="65535"/>
|
||
</unsignedInt>
|
||
<default type="object" value="1024"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="LocalPortMax" access="readWrite" version="2.0">
|
||
<description>
|
||
Top of port range to be used for incoming RTP streams for this profile.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<range minInclusive="1" maxInclusive="65535"/>
|
||
</unsignedInt>
|
||
<default type="object" value="1024"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Gmin" access="readWrite" version="2.0">
|
||
<description>
|
||
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 ({{param}} - 1) received packets (a sequence of {{param}} received packets terminates the Loss Event, and so is not an island).
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<range minInclusive="1" maxInclusive="255"/>
|
||
</unsignedInt>
|
||
<default type="object" value="16"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="DSCPMark" access="readWrite" version="2.0">
|
||
<description>
|
||
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.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<range minInclusive="0" maxInclusive="63"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="VLANIDMark" access="readWrite" version="2.0">
|
||
<description>
|
||
VLAN ID (as defined in {{bibref|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 {{param}} or {{param|EthernetPriorityMark}} is greater than zero, then the outgoing frames MUST be tagged. Otherwise, the outgoing frames MAY be tagged or untagged.
|
||
</description>
|
||
<syntax>
|
||
<int>
|
||
<range minInclusive="-1"/>
|
||
</int>
|
||
<default type="object" value="-1"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="EthernetPriorityMark" access="readWrite" version="2.0">
|
||
<description>
|
||
Ethernet priority code (as defined in {{bibref|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 {{param|VLANIDMark}} or {{param}} is greater than zero, then the outgoing frames MUST be tagged. Otherwise, the outgoing frames MAY be tagged or untagged.
|
||
</description>
|
||
<syntax>
|
||
<int>
|
||
<range minInclusive="-1"/>
|
||
</int>
|
||
<default type="object" value="-1"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="TelephoneEventPayloadType" access="readWrite" version="2.0">
|
||
<description>
|
||
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 {{bibref|RFC4733}}.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<range minInclusive="0" maxInclusive="128"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="JitterBufferType" access="readWrite" version="2.0">
|
||
<description>
|
||
The indicates if the jitte buffer is static or dynamic.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="Static" version="2.0"/>
|
||
<enumeration value="Dynamic" version="2.0"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="JitterBufferMaxSize" access="readWrite" version="2.0">
|
||
<description>
|
||
Maximal (or static) jitter buffer size in {{units}}.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<units value="milliseconds"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="JitterBufferMinSize" access="readWrite" version="2.0">
|
||
<description>
|
||
Minimal jitter buffer size in {{units}}, not used if static buffer is used.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<units value="milliseconds"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="JitterBufferActualSize" access="readWrite" version="2.0">
|
||
<description>
|
||
Actual jitter buffer size in {{units}}, if static buffer ist used equal to {{param|JitterBufferMaxSize}}.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<units value="milliseconds"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.VoIPProfile.{i}.RTP.RTCP." access="readOnly" minEntries="1" maxEntries="1" version="2.0">
|
||
<description>
|
||
VoIP profile parameters related to RTCP.
|
||
</description>
|
||
<parameter name="Enable" access="readWrite" version="2.0">
|
||
<description>
|
||
Enable or disable RTCP.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="TxRepeatInterval" access="readWrite" version="2.0">
|
||
<description>
|
||
Transmission repeat interval, in {{units}}.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<range minInclusive="1"/>
|
||
<units value="milliseconds"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="LocalCName" access="readWrite" version="2.0">
|
||
<description>
|
||
Local Cname (canonical name).
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="64"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.VoIPProfile.{i}.RTP.SRTP." access="readOnly" minEntries="1" maxEntries="1" version="2.0">
|
||
<description>
|
||
VoIP profile parameters for secure voice transmission via SRTP.
|
||
</description>
|
||
<parameter name="Enable" access="readWrite" version="2.0">
|
||
<description>
|
||
Enable or disable the use of SRTP.
|
||
If RTCP is enabled, a {{true}} value of this parameter also implies the use of SRTCP.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="KeyingMethods" access="readWrite" version="2.0">
|
||
<description>
|
||
{{list|available keying methods}} {{enum}}
|
||
</description>
|
||
<syntax>
|
||
<list/>
|
||
<string>
|
||
<enumeration value="Null" version="2.0"/>
|
||
<enumeration value="Static" version="2.0"/>
|
||
<enumeration value="SDP" version="2.0"/>
|
||
<enumeration value="IKE" version="2.0"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="EncryptionKeySizes" access="readWrite" version="2.0">
|
||
<description>
|
||
{{list|available encryption key sizes}}
|
||
</description>
|
||
<syntax>
|
||
<list/>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.VoIPProfile.{i}.RTP.Redundancy." access="readOnly" minEntries="1" maxEntries="1" version="2.0">
|
||
<description>
|
||
VoIP profile parameters for RTP payload redundancy as defined by {{bibref|RFC2198}}.
|
||
</description>
|
||
<parameter name="Enable" access="readWrite" version="2.0">
|
||
<description>
|
||
Enable or disable the use of RTP payload redundancy as defined by {{bibref|RFC2198}}.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
<default type="object" value="false"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="PayloadType" access="readWrite" version="2.0">
|
||
<description>
|
||
The Payload Type of RTP packet as defined in {{bibref|RFC2198}}. Values SHOULD be within the range of dynamic Payload Types (96-127).
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<range minInclusive="0" maxInclusive="127"/>
|
||
</unsignedInt>
|
||
<default type="object" value="0"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="BlockPayloadType" access="readOnly" version="2.0">
|
||
<description>
|
||
Block Payload Type of redundancy packet.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<range minInclusive="0" maxInclusive="127"/>
|
||
</unsignedInt>
|
||
<default type="object" value="0"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="FaxAndModemRedundancy" access="readWrite" version="2.0">
|
||
<description>
|
||
Specifies the redundancy number for fax and modem pass-through data transmissions.
|
||
A non-negative value indicates that {{bibref|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 {{bibref|RFC2198}} is not to be used for fax and modem pass-through data.
|
||
If {{param|ModemRedundancy}} is present, then {{param}} applies only to fax transmissions, but not to modem transmissions.
|
||
</description>
|
||
<syntax>
|
||
<int>
|
||
<range minInclusive="-1" maxInclusive="5"/>
|
||
</int>
|
||
<default type="object" value="-1"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="ModemRedundancy" access="readWrite" version="2.0">
|
||
<description>
|
||
Specifies the redundancy number for modem pass-through data transmissions.
|
||
A non-negative value indicates that {{bibref|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 {{bibref|RFC2198}} is not to be used for modem pass-through data.
|
||
</description>
|
||
<syntax>
|
||
<int>
|
||
<range minInclusive="-1" maxInclusive="5"/>
|
||
</int>
|
||
<default type="object" value="-1"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="DTMFRedundancy" access="readWrite" version="2.0">
|
||
<description>
|
||
Specifies the redundancy number for DTMF transmissions.
|
||
A non-negative value indicates that {{bibref|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 {{bibref|RFC2198}} is not to be used for DTMF.
|
||
</description>
|
||
<syntax>
|
||
<int>
|
||
<range minInclusive="-1" maxInclusive="5"/>
|
||
</int>
|
||
<default type="object" value="-1"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="VoiceRedundancy" access="readWrite" version="2.0">
|
||
<description>
|
||
Specifies the redundancy number for general voice transmissions.
|
||
A non-negative value indicates that {{bibref|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 {{bibref|RFC2198}} is not to be used for voice.
|
||
</description>
|
||
<syntax>
|
||
<int>
|
||
<range minInclusive="-1" maxInclusive="5"/>
|
||
</int>
|
||
<default type="object" value="-1"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="MaxSessionsUsingRedundancy" access="readWrite" version="2.0">
|
||
<description>
|
||
The maximum number of sessions using {{bibref|RFC2198}} payload redundancy simultaneously in this profile.
|
||
A value of zero indicates no explicit limit on the number of sessions using redundancy.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
<default type="object" value="0"/>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.VoIPProfile.{i}.FaxT38." access="readOnly" minEntries="1" maxEntries="1" version="2.0">
|
||
<description>
|
||
T.38 Fax information for devices that support T.38 relay.
|
||
</description>
|
||
<parameter name="MaxBitRate" access="readWrite" version="2.0">
|
||
<description>
|
||
Maximum data rate in {{units}} for fax as defined in {{bibref|T.38}}.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<range minInclusive="0" maxInclusive="65535"/>
|
||
<units value="bits per second"/>
|
||
</unsignedInt>
|
||
<default type="object" value="14400"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="HighSpeedRedundancy" access="readWrite" version="2.0">
|
||
<description>
|
||
Specifies the packet-level redundancy for high-speed data transmissions (i.e., T.4 image data).
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<range minInclusive="0" maxInclusive="3"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="LowSpeedRedundancy" access="readWrite" version="2.0">
|
||
<description>
|
||
Specifies the packet-level redundancy for low-speed data transmissions (i.e., T.30 handshaking information).
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<range minInclusive="0" maxInclusive="5"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="TCFMethod" access="readWrite" version="2.0">
|
||
<description>
|
||
The method with which data is handled over the network.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="Local" version="2.0"/>
|
||
<enumeration value="Network" version="2.0"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.CodecProfile.{i}." access="readWrite" numEntriesParameter="CodecProfileNumberOfEntries" enableParameter="Enable" minEntries="0" maxEntries="unbounded" version="2.0">
|
||
<description>
|
||
Table of codec profiles. This table MUST be populated with the set of supported codecs matching {{object|.Capabilities.Codec.}}. Additional entries can be added to use different configurations of codec or to use the same codec configuration in different CodecList parameters.
|
||
</description>
|
||
<uniqueKey functional="false">
|
||
<parameter ref="Alias"/>
|
||
</uniqueKey>
|
||
<parameter name="Enable" access="readWrite" version="2.0">
|
||
<description>
|
||
Enable or disable the use of this combination of codec parameters.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Alias" access="readWrite" activeNotify="canDeny" version="2.0">
|
||
<description>
|
||
{{datatype|expand}}
|
||
</description>
|
||
<syntax>
|
||
<dataType ref="Alias"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Codec" access="readOnly" version="2.0">
|
||
<description>
|
||
{{reference}}
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="256"/>
|
||
<pathRef refType="strong" targetParent=".Capabilities.Codec." targetType="row"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="PacketizationPeriod" access="readWrite" version="2.0">
|
||
<description>
|
||
{{list}} Each item is a supported packetization period, in milliseconds, or continuous ranges of packetization periods as defined in {{param|.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 {{param|.Capabilities.Codec.{i}.PacketizationPeriod}}. The CPE MUST ignore any values or portions of ranges outside of those specified in {{param|.Capabilities.Codec.{i}.PacketizationPeriod}}.
|
||
</description>
|
||
<syntax>
|
||
<list/>
|
||
<string>
|
||
<size maxLength="64"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="SilenceSuppression" access="readWrite" version="2.0">
|
||
<description>
|
||
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}}.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.Tone." access="readOnly" minEntries="1" maxEntries="1" version="2.0">
|
||
<description>
|
||
This object defines the contents of the tones and announcements generated locally by the VoIP device.
|
||
</description>
|
||
<parameter name="DescriptionNumberOfEntries" access="readOnly" version="2.0">
|
||
<description>
|
||
{{numentries}}
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="PatternNumberOfEntries" access="readOnly" version="2.0">
|
||
<description>
|
||
{{numentries}}
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="EventProfileNumberOfEntries" access="readOnly" version="2.0">
|
||
<description>
|
||
{{numentries}}
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="DefautEventProfile" access="readWrite" version="2.0">
|
||
<description>
|
||
Reference to the default tone event profile.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="256"/>
|
||
<pathRef refType="strong" targetParent=".Tone.EventProfile." targetType="row"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.Tone.Description.{i}." access="readWrite" numEntriesParameter="DescriptionNumberOfEntries" enableParameter="ToneEnable" minEntries="0" maxEntries="unbounded" version="2.0">
|
||
<description>
|
||
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.
|
||
</description>
|
||
<uniqueKey functional="false">
|
||
<parameter ref="Alias"/>
|
||
</uniqueKey>
|
||
<parameter name="ToneEnable" access="readWrite" version="2.0">
|
||
<description>
|
||
Enables or disables the tone entry. If a disabled tone entry is referenced, the result is that no tone is played.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
<default type="object" value="false"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Alias" access="readWrite" activeNotify="canDeny" version="2.0">
|
||
<description>
|
||
{{datatype|expand}}
|
||
</description>
|
||
<syntax>
|
||
<dataType ref="Alias"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="ToneName" access="readWrite" version="2.0">
|
||
<description>
|
||
Name of the tone.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="64"/>
|
||
</string>
|
||
<default type="object" value=""/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="TonePattern" access="readWrite" version="2.0">
|
||
<description>
|
||
This is the {{object|#.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 {{empty}}.
|
||
{{reference}}
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="256"/>
|
||
<pathRef refType="strong" targetParent="#.Pattern." targetType="row"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="ToneFile" access="readWrite" version="2.0">
|
||
<description>
|
||
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 {{bibref|TR-069a4|Annex A.3.2.8}} to download a tone file.
|
||
If the tone is specified by a tone pattern instead of a tone file, this parameter MUST be {{empty}}.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="256"/>
|
||
</string>
|
||
<default type="object" value=""/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="ToneRepetitions" access="readWrite" version="2.0">
|
||
<description>
|
||
The default number of times the data in {{param|ToneFile}} is repeated. If the value is 0 (zero) then {{param|ToneFile}} is played indefinitely.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<range minInclusive="0" maxInclusive="255"/>
|
||
</unsignedInt>
|
||
<default type="object" value="0"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="ToneText" access="readWrite" version="2.0">
|
||
<description>
|
||
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.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="64"/>
|
||
</string>
|
||
<default type="object" value=""/>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.Tone.Pattern.{i}." access="readWrite" numEntriesParameter="PatternNumberOfEntries" enableParameter="Enable" minEntries="0" maxEntries="unbounded" version="2.0">
|
||
<description>
|
||
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.
|
||
</description>
|
||
<uniqueKey functional="false">
|
||
<parameter ref="Alias"/>
|
||
</uniqueKey>
|
||
<parameter name="Enable" access="readWrite" version="2.0">
|
||
<description>
|
||
Enables or disables this entry.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
<default type="object" value="false"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Alias" access="readWrite" activeNotify="canDeny" version="2.0">
|
||
<description>
|
||
{{datatype|expand}}
|
||
</description>
|
||
<syntax>
|
||
<dataType ref="Alias"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="ToneOn" access="readWrite" version="2.0">
|
||
<description>
|
||
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.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
<default type="object" value="false"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Frequency1" access="readWrite" version="2.0">
|
||
<description>
|
||
First tone frequency in {{units}}.
|
||
A value of zero indicates this tone component is not used.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<range minInclusive="0" maxInclusive="4095"/>
|
||
<units value="hertz"/>
|
||
</unsignedInt>
|
||
<default type="object" value="0"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Power1" access="readWrite" version="2.0">
|
||
<description>
|
||
First tone power level in units of 0.1 {{units}}.
|
||
</description>
|
||
<syntax>
|
||
<int>
|
||
<units value="dBm0"/>
|
||
</int>
|
||
<default type="object" value="0"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Frequency2" access="readWrite" version="2.0">
|
||
<description>
|
||
Second tone frequency in {{units}}.
|
||
A value of zero indicates this tone component is not used.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<range minInclusive="0" maxInclusive="4095"/>
|
||
<units value="hertz"/>
|
||
</unsignedInt>
|
||
<default type="object" value="0"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Power2" access="readWrite" version="2.0">
|
||
<description>
|
||
Second tone power level in units of 0.1 {{units}}.
|
||
</description>
|
||
<syntax>
|
||
<int>
|
||
<units value="dBm0"/>
|
||
</int>
|
||
<default type="object" value="0"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Frequency3" access="readWrite" version="2.0">
|
||
<description>
|
||
Third tone frequency in {{units}}.
|
||
A value of zero indicates this tone component is not used.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<range minInclusive="0" maxInclusive="4095"/>
|
||
<units value="hertz"/>
|
||
</unsignedInt>
|
||
<default type="object" value="0"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Power3" access="readWrite" version="2.0">
|
||
<description>
|
||
Third tone power level in units of 0.1 {{units}}.
|
||
</description>
|
||
<syntax>
|
||
<int>
|
||
<units value="dBm0"/>
|
||
</int>
|
||
<default type="object" value="0"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Frequency4" access="readWrite" version="2.0">
|
||
<description>
|
||
Fourth tone frequency in {{units}}.
|
||
A value of zero indicates this tone component is not used.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<range minInclusive="0" maxInclusive="4095"/>
|
||
<units value="herts"/>
|
||
</unsignedInt>
|
||
<default type="object" value="0"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Power4" access="readWrite" version="2.0">
|
||
<description>
|
||
Fourth tone power level in units of 0.1 {{units}}.
|
||
</description>
|
||
<syntax>
|
||
<int>
|
||
<units value="dBm0"/>
|
||
</int>
|
||
<default type="object" value="0"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="ModulationFrequency" access="readWrite" version="2.0">
|
||
<description>
|
||
Modulation frequency in {{units}}.
|
||
A value of zero indicates this tone component is not used.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<range minInclusive="0" maxInclusive="4095"/>
|
||
<units value="hertz"/>
|
||
</unsignedInt>
|
||
<default type="object" value="0"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="ModulationPower" access="readWrite" version="2.0">
|
||
<description>
|
||
Modulation power level in units of 0.1 {{units}}.
|
||
</description>
|
||
<syntax>
|
||
<int>
|
||
<units value="dBm0"/>
|
||
</int>
|
||
<default type="object" value="0"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Duration" access="readWrite" version="2.0">
|
||
<description>
|
||
The duration of this phase of the tone pattern, in {{units}}.
|
||
A value of zero indicates an unlimited duration.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<units value="milliseconds"/>
|
||
</unsignedInt>
|
||
<default type="object" value="0"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="NextPattern" access="readWrite" version="2.0">
|
||
<description>
|
||
The {{object}} for the next phase of the tone pattern, after the specified {{param|Duration}} of this phase has completed.
|
||
{{reference}}
|
||
{{empty}} indicates that the tone pattern is to terminate after the current phase is completed.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="256"/>
|
||
<pathRef refType="strong" targetParent="#.Pattern." targetType="row"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.Tone.EventProfile.{i}." access="readWrite" numEntriesParameter="EventProfileNumberOfEntries" minEntries="0" maxEntries="unbounded" version="2.0">
|
||
<description>
|
||
Configuration profile for tone events.
|
||
</description>
|
||
<uniqueKey functional="false">
|
||
<parameter ref="Alias"/>
|
||
</uniqueKey>
|
||
<parameter name="Alias" access="readWrite" activeNotify="canDeny" version="2.0">
|
||
<description>
|
||
{{datatype|expand}}
|
||
</description>
|
||
<syntax>
|
||
<dataType ref="Alias"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="EventNumberOfEntries" access="readOnly" version="2.0">
|
||
<description>
|
||
{{numentries}}
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.Tone.EventProfile.{i}.Event.{i}." access="readWrite" numEntriesParameter="EventNumberOfEntries" minEntries="0" maxEntries="unbounded" version="2.0">
|
||
<description>
|
||
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.
|
||
</description>
|
||
<uniqueKey functional="false">
|
||
<parameter ref="Alias"/>
|
||
</uniqueKey>
|
||
<parameter name="Alias" access="readWrite" activeNotify="canDeny" version="2.0">
|
||
<description>
|
||
{{datatype|expand}}
|
||
</description>
|
||
<syntax>
|
||
<dataType ref="Alias"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Function" access="readWrite" version="2.0">
|
||
<description>
|
||
The event for which the tone is to apply. {{enum}}
|
||
The parameter MAY instead indicate a vendor-specific event name, which MUST use the format defined in {{bibref|TR-106}}.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="Busy" version="2.0"/>
|
||
<enumeration value="Confirmation" version="2.0"/>
|
||
<enumeration value="Dial" version="2.0"/>
|
||
<enumeration value="LineMessagesWaiting" version="2.0"/>
|
||
<enumeration value="OffHookWarning" version="2.0"/>
|
||
<enumeration value="RingBack" version="2.0"/>
|
||
<enumeration value="ReOrder" version="2.0"/>
|
||
<enumeration value="Stutterdial" version="2.0"/>
|
||
<enumeration value="CallWaiting1" version="2.0"/>
|
||
<enumeration value="CallWaiting2" version="2.0"/>
|
||
<enumeration value="CallWaiting3" version="2.0"/>
|
||
<enumeration value="CallWaiting4" version="2.0"/>
|
||
<enumeration value="AlertingSignal" version="2.0"/>
|
||
<enumeration value="SpecialDial" version="2.0"/>
|
||
<enumeration value="SpecialInfo" version="2.0"/>
|
||
<enumeration value="Release" version="2.0"/>
|
||
<enumeration value="Congestion" version="2.0"/>
|
||
<enumeration value="UserDefined1" version="2.0"/>
|
||
<enumeration value="UserDefined2" version="2.0"/>
|
||
<enumeration value="UserDefined3" version="2.0"/>
|
||
<enumeration value="UserDefined4" version="2.0"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Tone" access="readWrite" version="2.0">
|
||
<description>
|
||
The description for the tone to be associated with the given event.
|
||
{{reference}}
|
||
{{empty}} indicates no tone is to be played for this event.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="256"/>
|
||
<pathRef refType="strong" targetParent=".Tone.Description." targetType="row"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.Terminal.{i}." access="readOnly" numEntriesParameter="TerminalNumberOfEntries" minEntries="1" maxEntries="unbounded" version="2.0">
|
||
<description>
|
||
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.
|
||
</description>
|
||
<uniqueKey functional="false">
|
||
<parameter ref="Alias"/>
|
||
</uniqueKey>
|
||
<parameter name="Enable" access="readWrite" version="2.0">
|
||
<description>
|
||
Enables or disables this terminal.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="QuiescentMode" access="readWrite" version="2.0">
|
||
<description>
|
||
If {{true}}, when {{param|Enable}} is set to {{false}} in-progress sessions remain intact, but no new sessions are allowed. When all sessions are terminated, the {{object}} is disabled.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Status" access="readOnly" version="2.0">
|
||
<description>
|
||
Indicates the status of this terminal.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="Up" version="2.0"/>
|
||
<enumeration value="Initializing" version="2.0"/>
|
||
<enumeration value="Registering" version="2.0"/>
|
||
<enumeration value="Unregistering" version="2.0"/>
|
||
<enumeration value="Error" version="2.0"/>
|
||
<enumeration value="Testing" version="2.0"/>
|
||
<enumeration value="Quiescent" version="2.0"/>
|
||
<enumeration value="Disabled" version="2.0"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Alias" access="readWrite" activeNotify="canDeny" version="2.0">
|
||
<description>
|
||
{{datatype|expand}}
|
||
</description>
|
||
<syntax>
|
||
<dataType ref="Alias"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="ToneEventProfile" access="readWrite" version="2.0">
|
||
<description>
|
||
Reference to the {{object|.Tone.EventProfile}} to use with this terminal. If this parameter is {{empty}}, the value of {{param|.Tone.DefautEventProfile}} is used instead.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="256"/>
|
||
<pathRef refType="strong" targetParent=".Tone.EventProfile." targetType="row"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="AudioNumberOfEntries" access="readOnly" version="2.0">
|
||
<description>
|
||
{{numentries}}
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
<command name="DiagTests()" async="true" version="2.0">
|
||
<description>
|
||
This command provides access to an Terminal Diag tests.
|
||
</description>
|
||
<input>
|
||
<description>
|
||
Input arguments.
|
||
</description>
|
||
<parameter name="TestSelector" version="2.0">
|
||
<description>
|
||
Indicates which test to perform.
|
||
The parameter MAY instead indicate a vendor-specific test, which MUST use the format defined in {{bibref|TR-106}}. For example:
|
||
"X_EXAMPLE-COM_MyTest"
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="RingingTest" version="2.0"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
</input>
|
||
<output>
|
||
<description>
|
||
Output arguments.
|
||
</description>
|
||
<parameter name="Status" version="2.0">
|
||
<description>
|
||
Indicates the availability of diagnostics data. {{enum}}
|
||
If the value of this parameter is anything other than {{enum|Complete}}, the values of the other results parameters for this test are indeterminate.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<enumeration value="Canceled" optional="true" version="2.0"/>
|
||
<enumeration value="Complete" version="2.0"/>
|
||
<enumeration value="Error" optional="true" version="2.0"/>
|
||
<enumeration value="Error_Internal" version="2.0"/>
|
||
<enumeration value="Error_Other" version="2.0"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="PhoneRinging" version="2.0">
|
||
<description>
|
||
Indicates whether or not the phone associated with this port is ringing. This parameter is applicable only if {{enum|RingingTest|TestSelector}} is supported.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
</syntax>
|
||
</parameter>
|
||
</output>
|
||
</command>
|
||
</object>
|
||
<object name="VoiceService.{i}.Terminal.{i}.Audio.{i}." access="readOnly" numEntriesParameter="AudioNumberOfEntries" minEntries="1" maxEntries="unbounded" version="2.0">
|
||
<description>
|
||
This object models the audio outputs of a telephony terminal.(ex. Handset, handsfree, ...)
|
||
</description>
|
||
<uniqueKey functional="false">
|
||
<parameter ref="Alias"/>
|
||
</uniqueKey>
|
||
<parameter name="Alias" access="readWrite" activeNotify="canDeny" version="2.0">
|
||
<description>
|
||
{{datatype|expand}}
|
||
</description>
|
||
<syntax>
|
||
<dataType ref="Alias"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Name" access="readWrite" version="2.0">
|
||
<description>
|
||
The internal name of this audio.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="256"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.Terminal.{i}.Audio.{i}.VoiceProcessing." access="readOnly" minEntries="1" maxEntries="1" version="2.0">
|
||
<description>
|
||
Parameters related to voice processing capabilities.
|
||
</description>
|
||
<parameter name="TransmitGain" access="readWrite" version="2.0">
|
||
<description>
|
||
Gain in {{units}} to apply to the transmitted voice signal prior to encoding. This gain is a modifier of the default transmit-gain, which is unspecified.
|
||
</description>
|
||
<syntax>
|
||
<int>
|
||
<units value="0.1 dB"/>
|
||
</int>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="ReceiveGain" access="readWrite" version="2.0">
|
||
<description>
|
||
Gain in {{units}} to apply to the received voice signal after decoding. This gain is a modifier of the default receive-gain, which is unspecified.
|
||
</description>
|
||
<syntax>
|
||
<int>
|
||
<units value="0.1 dB"/>
|
||
</int>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="EchoCancellationEnable" access="readWrite" version="2.0">
|
||
<description>
|
||
Enable or disable echo cancellation for this line.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="EchoCancellationInUse" access="readOnly" version="2.0">
|
||
<description>
|
||
Indication of whether or not echo cancellation is currently in use for this line.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="EchoCancellationTail" access="readOnly" version="2.0">
|
||
<description>
|
||
Tail length in {{units}} of the echo canceller associated with this line (whether or not it is currently in use).
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<units value="milliseconds"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.Terminal.{i}.ButtonMap." access="readOnly" minEntries="1" maxEntries="1" version="2.0">
|
||
<description>
|
||
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.
|
||
</description>
|
||
<parameter name="ButtonNumberOfEntries" access="readOnly" version="2.0">
|
||
<description>
|
||
{{numentries}}
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.Terminal.{i}.ButtonMap.Button.{i}." access="readOnly" numEntriesParameter="ButtonNumberOfEntries" minEntries="1" maxEntries="unbounded" version="2.0">
|
||
<description>
|
||
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.
|
||
</description>
|
||
<uniqueKey functional="false">
|
||
<parameter ref="Alias"/>
|
||
</uniqueKey>
|
||
<parameter name="Alias" access="readWrite" activeNotify="canDeny" version="2.0">
|
||
<description>
|
||
{{datatype|expand}}
|
||
</description>
|
||
<syntax>
|
||
<dataType ref="Alias"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="ButtonName" access="readOnly" version="2.0">
|
||
<description>
|
||
Name of the button.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="16"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="FacilityAction" access="readWrite" version="2.0">
|
||
<description>
|
||
The value MUST be a member of the list reported by {{param|.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 {{bibref|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 {{empty}}) then {{param|QuickDialNumber}} SHOULD be {{empty}}.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="64"/>
|
||
<enumerationRef targetParam=".Capabilities.FacilityActions" nullValue=""/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="FacilityActionArgument" access="readWrite" version="2.0">
|
||
<description>
|
||
Optional argument associated with the specified {{param|FacilityAction}}. The interpretation of the argument is dependent on the specific FacilityAction.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="256"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="QuickDialNumber" access="readWrite" version="2.0">
|
||
<description>
|
||
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 {{empty}}) then {{param|FacilityAction}} SHOULD be {{empty}}.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="40"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="ButtonMessage" access="readWrite" version="2.0">
|
||
<description>
|
||
This string represents the message to be displayed on the screen when the button or function key is pressed.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="64"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="UserAccess" access="readWrite" version="2.0">
|
||
<description>
|
||
This parameter indicates whether the user has permission to program the button or function key. If this parameter is set to {{true}} then {{param|FacilityAction}}, {{param|QuickDialNumber}} and {{param|ButtonMessage}} MUST all be {{empty}}.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.Terminal.{i}.Ringer." access="readOnly" minEntries="1" maxEntries="1" version="2.0">
|
||
<description>
|
||
This object defines the ring sequences that may be generated by the terminal.
|
||
</description>
|
||
<parameter name="DescriptionNumberOfEntries" access="readOnly" version="2.0">
|
||
<description>
|
||
{{numentries}}
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="PatternNumberOfEntries" access="readOnly" version="2.0">
|
||
<description>
|
||
{{numentries}}
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.Terminal.{i}.Ringer.Description.{i}." access="readWrite" numEntriesParameter="DescriptionNumberOfEntries" enableParameter="RingEnable" minEntries="0" maxEntries="unbounded" version="2.0">
|
||
<description>
|
||
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.
|
||
</description>
|
||
<uniqueKey functional="false">
|
||
<parameter ref="Alias"/>
|
||
</uniqueKey>
|
||
<parameter name="RingEnable" access="readWrite" version="2.0">
|
||
<description>
|
||
Enables or disables the ring description entry. If a disabled ring description entry is referenced, the result is that no ring is played.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
<default type="object" value="false"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Alias" access="readWrite" activeNotify="canDeny" version="2.0">
|
||
<description>
|
||
{{datatype|expand}}
|
||
</description>
|
||
<syntax>
|
||
<dataType ref="Alias"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="RingName" access="readWrite" version="2.0">
|
||
<description>
|
||
Name of the ring.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="64"/>
|
||
</string>
|
||
<default type="object" value=""/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="RingPattern" access="readWrite" version="2.0">
|
||
<description>
|
||
This is the {{object|#.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 {{empty}}.
|
||
{{reference}}
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="256"/>
|
||
<pathRef refType="strong" targetParent="#.Pattern." targetType="row"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="RingFile" access="readWrite" version="2.0">
|
||
<description>
|
||
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 {{bibref|TR-069a4|Annex A.3.2.8}} to download a ring file.
|
||
If the ring is specified by a ring pattern instead of a ring file, this parameter MUST be {{empty}}.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="256"/>
|
||
</string>
|
||
<default type="object" value=""/>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.Terminal.{i}.Ringer.Pattern.{i}." access="readWrite" numEntriesParameter="PatternNumberOfEntries" enableParameter="Enable" minEntries="0" maxEntries="unbounded" version="2.0">
|
||
<description>
|
||
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.
|
||
</description>
|
||
<uniqueKey functional="false">
|
||
<parameter ref="Alias"/>
|
||
</uniqueKey>
|
||
<parameter name="Enable" access="readWrite" version="2.0">
|
||
<description>
|
||
Enables or disables this entry.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
<default type="object" value="false"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Alias" access="readWrite" activeNotify="canDeny" version="2.0">
|
||
<description>
|
||
{{datatype|expand}}
|
||
</description>
|
||
<syntax>
|
||
<dataType ref="Alias"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="RingerOn" access="readWrite" version="2.0">
|
||
<description>
|
||
Whether or not a ringer is on during this phase of the pattern.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
<default type="object" value="false"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Duration" access="readWrite" version="2.0">
|
||
<description>
|
||
The duration of this phase of the ring pattern, in {{units}}.
|
||
A value of zero indicates an unlimited duration.
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<units value="milliseconds"/>
|
||
</unsignedInt>
|
||
<default type="object" value="0"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="NextPattern" access="readWrite" version="2.0">
|
||
<description>
|
||
The {{object}} for the next phase of the ring pattern, after the specified {{param|Duration}} of this phase has completed.
|
||
{{reference}}
|
||
{{empty}} indicates that the ring pattern is to terminate after the current phase is completed.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="256"/>
|
||
<pathRef refType="strong" targetParent="#.Pattern." targetType="row"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.ClockSynchronization." access="readOnly" minEntries="1" maxEntries="1" version="2.0">
|
||
<description>
|
||
Clock source configuration for Time-Division multiplexing subsystem.
|
||
</description>
|
||
<parameter name="ClockSourceNumberOfEntries" access="readOnly" version="2.0">
|
||
<description>
|
||
{{numentries}}
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="CurrentSource" access="readWrite" version="2.0">
|
||
<description>
|
||
The currently selected external clock source. If the current clock source is not selected from the {{object|ClockSource}} table, e.g. an internal holdover clock, this parameter is set to {{empty}}.
|
||
{{reference}}
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="256"/>
|
||
<pathRef refType="strong" targetParent=".ClockSynchronization.ClockSource." targetType="row"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Description" access="readOnly" version="2.0">
|
||
<description>
|
||
Human readable description of the current clock synchronization status.
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="64"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="AutoRevert" access="readWrite" version="2.0">
|
||
<description>
|
||
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.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<object name="VoiceService.{i}.ClockSynchronization.ClockSource.{i}." access="readOnly" numEntriesParameter="ClockSourceNumberOfEntries" minEntries="0" maxEntries="unbounded" version="2.0">
|
||
<description>
|
||
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.
|
||
</description>
|
||
<uniqueKey functional="false">
|
||
<parameter ref="Alias"/>
|
||
</uniqueKey>
|
||
<uniqueKey>
|
||
<parameter ref="Order"/>
|
||
</uniqueKey>
|
||
<uniqueKey>
|
||
<parameter ref="Interface"/>
|
||
</uniqueKey>
|
||
<parameter name="Enable" access="readWrite" version="2.0">
|
||
<description>
|
||
Enables or disables this entry.
|
||
</description>
|
||
<syntax>
|
||
<boolean/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Alias" access="readWrite" activeNotify="canDeny" version="2.0">
|
||
<description>
|
||
{{datatype|expand}}
|
||
</description>
|
||
<syntax>
|
||
<dataType ref="Alias"/>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Order" access="readWrite" version="2.0">
|
||
<description>
|
||
Position of the {{object}} entry in the order of precedence. A value of "1" indicates the first entry considered (highest precedence).
|
||
</description>
|
||
<syntax>
|
||
<unsignedInt>
|
||
<range minInclusive="1" maxInclusive="100"/>
|
||
</unsignedInt>
|
||
</syntax>
|
||
</parameter>
|
||
<parameter name="Interface" access="readWrite" version="2.0">
|
||
<description>
|
||
A reference to a physical interface from which a clock signal can be derived. {{object|.ISDN.PRI.{i}.}} is eligible as a clock source when {{param|.ISDN.PRI.{i}.ClockMode}} is {{enum|Slave|.ISDN.PRI.{i}.ClockMode}}. {{object|.ISDN.BRI.{i}.}} is eligible as a clock source when {{param|.ISDN.BRI.{i}.ProtocolEmulation}} is {{enum|TE|.ISDN.BRI.{i}.ProtocolEmulation}}.
|
||
{{reference}}
|
||
</description>
|
||
<syntax>
|
||
<string>
|
||
<size maxLength="256"/>
|
||
<pathRef refType="strong" targetParent=".ISDN.BRI. .ISDN.PRI." targetType="row"/>
|
||
</string>
|
||
</syntax>
|
||
</parameter>
|
||
</object>
|
||
<profile name="Baseline:1" version="2.0">
|
||
<parameter ref="VoiceServiceNumberOfEntries" requirement="readOnly"/>
|
||
<object ref="VoiceService.{i}." requirement="present">
|
||
<parameter ref="CodecProfileNumberOfEntries" requirement="readOnly"/>
|
||
</object>
|
||
<object ref="VoiceService.{i}.Capabilities." requirement="present">
|
||
<parameter ref="NetworkConnectionModes" requirement="readOnly"/>
|
||
<parameter ref="UserConnectionModes" requirement="readOnly"/>
|
||
<parameter ref="CodecNumberOfEntries" requirement="readOnly"/>
|
||
<parameter ref="ToneFileFormats" requirement="readOnly"/>
|
||
<parameter ref="RingFileFormats" requirement="readOnly"/>
|
||
<parameter ref="FacilityActions" requirement="readOnly"/>
|
||
</object>
|
||
<object ref="VoiceService.{i}.Capabilities.Codec.{i}." requirement="present">
|
||
<parameter ref="Codec" requirement="readOnly"/>
|
||
<parameter ref="BitRate" requirement="readOnly"/>
|
||
<parameter ref="PacketizationPeriod" requirement="readOnly"/>
|
||
<parameter ref="SilenceSuppression" requirement="readOnly"/>
|
||
</object>
|
||
<object ref="VoiceService.{i}.Capabilities.QualityIndicator." requirement="present">
|
||
<parameter ref="MaxQIValues" requirement="readOnly"/>
|
||
<parameter ref="MaxWorstQIValues" requirement="readOnly"/>
|
||
</object>
|
||
<object ref="VoiceService.{i}.CodecProfile.{i}." requirement="present">
|
||
<parameter ref="Enable" requirement="readOnly"/>
|
||
<parameter ref="Alias" requirement="readWrite"/>
|
||
<parameter ref="Codec" requirement="readOnly"/>
|
||
<parameter ref="PacketizationPeriod" requirement="readOnly"/>
|
||
<parameter ref="SilenceSuppression" requirement="readOnly"/>
|
||
</object>
|
||
</profile>
|
||
<profile name="ISDN:1" version="2.0">
|
||
<object ref="VoiceService.{i}.Capabilities.ISDN." requirement="present">
|
||
<parameter ref="MSN" requirement="readOnly"/>
|
||
<parameter ref="DDI" requirement="readOnly"/>
|
||
<parameter ref="MCID" requirement="readOnly"/>
|
||
<parameter ref="MWI" requirement="readOnly"/>
|
||
<parameter ref="AoC" requirement="readOnly"/>
|
||
<parameter ref="ECT" requirement="readOnly"/>
|
||
</object>
|
||
</profile>
|
||
<profile name="ISDNBRI:1" extends="ISDN:1" version="2.0">
|
||
<object ref="VoiceService.{i}.ISDN." requirement="present">
|
||
<parameter ref="BRINumberOfEntries" requirement="readOnly"/>
|
||
</object>
|
||
<object ref="VoiceService.{i}.ISDN.BRI.{i}." requirement="present">
|
||
<parameter ref="Enable" requirement="readWrite"/>
|
||
<parameter ref="Status" requirement="readOnly"/>
|
||
<parameter ref="Name" requirement="readOnly"/>
|
||
<parameter ref="ApplicationInterface" requirement="readOnly"/>
|
||
<parameter ref="Protocol" requirement="readOnly"/>
|
||
<parameter ref="ProtocolEmulation" requirement="readOnly"/>
|
||
<parameter ref="PermanentLayer2" requirement="readOnly"/>
|
||
<parameter ref="PermanentLayer1" requirement="readOnly"/>
|
||
<parameter ref="LapdDisconnectionTimeout" requirement="readOnly"/>
|
||
<parameter ref="TEINegotiation" requirement="readOnly"/>
|
||
<parameter ref="StaticTEI" requirement="readOnly"/>
|
||
<parameter ref="LifeLineHold" requirement="readWrite"/>
|
||
<parameter ref="PowerSourceOne" requirement="readOnly"/>
|
||
<parameter ref="MaxNumBChannels" requirement="readOnly"/>
|
||
<parameter ref="InboundOnlyBChannels" requirement="readWrite"/>
|
||
<parameter ref="OutboundOnlyBChannels" requirement="readWrite"/>
|
||
<parameter ref="BidirectionalBChannels" requirement="readWrite"/>
|
||
</object>
|
||
</profile>
|
||
<profile name="ISDNPRI:1" extends="ISDN:1" version="2.0">
|
||
<object ref="VoiceService.{i}.ISDN." requirement="present">
|
||
<parameter ref="PRINumberOfEntries" requirement="readOnly"/>
|
||
</object>
|
||
<object ref="VoiceService.{i}.ISDN.PRI.{i}." requirement="present">
|
||
<parameter ref="Enable" requirement="readWrite"/>
|
||
<parameter ref="Status" requirement="readOnly"/>
|
||
<parameter ref="Name" requirement="readOnly"/>
|
||
<parameter ref="ApplicationInterface" requirement="readOnly"/>
|
||
<parameter ref="Protocol" requirement="readOnly"/>
|
||
<parameter ref="ProtocolEmulation" requirement="readOnly"/>
|
||
<parameter ref="PermanentLayer2" requirement="readOnly"/>
|
||
<parameter ref="Linecode" requirement="readOnly"/>
|
||
<parameter ref="ESF" requirement="readOnly"/>
|
||
<parameter ref="PhysicalInterfaceType" requirement="readOnly"/>
|
||
<parameter ref="MaxNumBChannels" requirement="readOnly"/>
|
||
<parameter ref="InboundOnlyBChannels" requirement="readWrite"/>
|
||
<parameter ref="OutboundOnlyBChannels" requirement="readWrite"/>
|
||
<parameter ref="BidirectionalBChannels" requirement="readWrite"/>
|
||
</object>
|
||
</profile>
|
||
<profile name="POTS:1" version="2.0"/>
|
||
<profile name="POTSFXO:1" extends="POTS:1" version="2.0">
|
||
<object ref="VoiceService.{i}.POTS." requirement="present">
|
||
<parameter ref="FXONumberOfEntries" requirement="readOnly"/>
|
||
</object>
|
||
<object ref="VoiceService.{i}.POTS.FXO.{i}." requirement="present">
|
||
<parameter ref="Enable" requirement="readWrite"/>
|
||
<parameter ref="Status" requirement="readOnly"/>
|
||
<parameter ref="Name" requirement="readOnly"/>
|
||
<parameter ref="SecondStepDialing" requirement="readOnly"/>
|
||
<parameter ref="TimeoutBeforeDialing" requirement="readOnly"/>
|
||
<parameter ref="RingingTimeout" requirement="readOnly"/>
|
||
<parameter ref="RingNumber" requirement="readOnly"/>
|
||
<parameter ref="OnHookMinDuration" requirement="readOnly"/>
|
||
</object>
|
||
</profile>
|
||
<profile name="POTSFXS:1" extends="POTS:1" version="2.0">
|
||
<object ref="VoiceService.{i}.POTS." requirement="present">
|
||
<parameter ref="FXSNumberOfEntries" requirement="readOnly"/>
|
||
</object>
|
||
<object ref="VoiceService.{i}.POTS.FXS.{i}." requirement="present">
|
||
<parameter ref="Enable" requirement="readWrite"/>
|
||
<parameter ref="Status" requirement="readOnly"/>
|
||
<parameter ref="Name" requirement="readOnly"/>
|
||
<parameter ref="Active" requirement="readOnly"/>
|
||
</object>
|
||
<object ref="VoiceService.{i}.POTS.Ringer." requirement="present">
|
||
<parameter ref="EventNumberOfEntries" requirement="readOnly"/>
|
||
</object>
|
||
</profile>
|
||
<profile name="DECT:1" version="2.0">
|
||
<object ref="VoiceService.{i}.DECT." requirement="present">
|
||
<parameter ref="BaseNumberOfEntries" requirement="readOnly"/>
|
||
<parameter ref="PortableNumberOfEntries" requirement="readOnly"/>
|
||
</object>
|
||
<object ref="VoiceService.{i}.DECT.Base.{i}." requirement="present">
|
||
<parameter ref="Enable" requirement="readWrite"/>
|
||
<parameter ref="Status" requirement="readOnly"/>
|
||
<parameter ref="Name" requirement="readOnly"/>
|
||
<parameter ref="Standard" requirement="readOnly"/>
|
||
<parameter ref="RFPI" requirement="readOnly"/>
|
||
</object>
|
||
<object ref="VoiceService.{i}.DECT.Portable.{i}." requirement="present">
|
||
<parameter ref="Enable" requirement="readWrite"/>
|
||
<parameter ref="Status" requirement="readOnly"/>
|
||
<parameter ref="CodecList" requirement="readWrite"/>
|
||
</object>
|
||
</profile>
|
||
<profile name="VoIPProfile:1" version="2.0">
|
||
<object ref="VoiceService.{i}." requirement="present">
|
||
<parameter ref="VoIPProfileNumberOfEntries" requirement="readOnly"/>
|
||
</object>
|
||
<object ref="VoiceService.{i}.VoIPProfile.{i}." requirement="createDelete">
|
||
<parameter ref="Enable" requirement="readWrite"/>
|
||
<parameter ref="Name" requirement="readWrite"/>
|
||
<parameter ref="DTMFMethod" requirement="readWrite"/>
|
||
<parameter ref="DTMFMethodG711" requirement="readWrite"/>
|
||
</object>
|
||
<object ref="VoiceService.{i}.VoIPProfile.{i}.RTP." requirement="present">
|
||
<parameter ref="LocalPortMin" requirement="readWrite"/>
|
||
<parameter ref="LocalPortMax" requirement="readWrite"/>
|
||
<parameter ref="DSCPMark" requirement="readWrite"/>
|
||
<parameter ref="VLANIDMark" requirement="readWrite"/>
|
||
<parameter ref="EthernetPriorityMark" requirement="readWrite"/>
|
||
<parameter ref="TelephoneEventPayloadType" requirement="readWrite"/>
|
||
<parameter ref="JitterBufferType" requirement="readWrite"/>
|
||
<parameter ref="JitterBufferMaxSize" requirement="readWrite"/>
|
||
<parameter ref="JitterBufferMinSize" requirement="readWrite"/>
|
||
<parameter ref="JitterBufferActualSize" requirement="readWrite"/>
|
||
</object>
|
||
</profile>
|
||
<profile name="SIPClient:1" extends="VoIPProfile:1" version="2.0">
|
||
<object ref="VoiceService.{i}.Capabilities.SIP.Client." requirement="present">
|
||
<parameter ref="Extensions" requirement="readOnly"/>
|
||
<parameter ref="URISchemes" requirement="readOnly"/>
|
||
<parameter ref="EventTypes" requirement="readOnly"/>
|
||
<parameter ref="TLSAuthenticationProtocols" requirement="readOnly"/>
|
||
<parameter ref="TLSAuthenticationKeySizes" requirement="readOnly"/>
|
||
<parameter ref="TLSEncryptionProtocols" requirement="readOnly"/>
|
||
<parameter ref="TLSEncryptionKeySizes" requirement="readOnly"/>
|
||
<parameter ref="TLSKeyExchangeProtocols" requirement="readOnly"/>
|
||
</object>
|
||
<object ref="VoiceService.{i}.SIP." requirement="present">
|
||
<parameter ref="ClientNumberOfEntries" requirement="readOnly"/>
|
||
<parameter ref="NetworkNumberOfEntries" requirement="readOnly"/>
|
||
</object>
|
||
<object ref="VoiceService.{i}.SIP.Client.{i}." requirement="createDelete">
|
||
<parameter ref="Enable" requirement="readWrite"/>
|
||
<parameter ref="Status" requirement="readOnly"/>
|
||
<parameter ref="RegisterMode" requirement="readWrite"/>
|
||
<parameter ref="AuthUserName" requirement="readWrite"/>
|
||
<parameter ref="AuthPassword" requirement="readWrite"/>
|
||
<parameter ref="Network" requirement="readWrite"/>
|
||
<parameter ref="RegisterURI" requirement="readWrite"/>
|
||
</object>
|
||
<object ref="VoiceService.{i}.SIP.Network.{i}." requirement="createDelete">
|
||
<parameter ref="ProxyServer" requirement="readWrite"/>
|
||
<parameter ref="ProxyServerPort" requirement="readWrite"/>
|
||
<parameter ref="ProxyServerTransport" requirement="readWrite"/>
|
||
<parameter ref="RegistrarServer" requirement="readWrite"/>
|
||
<parameter ref="RegistrarServerPort" requirement="readWrite"/>
|
||
<parameter ref="RegistrarServerTransport" requirement="readWrite"/>
|
||
<parameter ref="UserAgentDomain" requirement="readWrite"/>
|
||
<parameter ref="UserAgentPort" requirement="readWrite"/>
|
||
<parameter ref="UserAgentTransport" requirement="readWrite"/>
|
||
<parameter ref="OutboundProxy" requirement="readWrite"/>
|
||
<parameter ref="OutboundProxyResolvedAddress" requirement="readOnly"/>
|
||
<parameter ref="OutboundProxyPort" requirement="readWrite"/>
|
||
<parameter ref="STUNEnable" requirement="readWrite"/>
|
||
<parameter ref="STUNServer" requirement="readWrite"/>
|
||
<parameter ref="NonVoiceBandwidthReservedUpstream" requirement="readWrite"/>
|
||
<parameter ref="NonVoiceBandwidthReservedDownstream" requirement="readWrite"/>
|
||
<parameter ref="Organization" requirement="readWrite"/>
|
||
<parameter ref="RegistrationPeriod" requirement="readWrite"/>
|
||
<parameter ref="Realm" requirement="readWrite"/>
|
||
<parameter ref="TimerT1" requirement="readWrite"/>
|
||
<parameter ref="TimerT2" requirement="readWrite"/>
|
||
<parameter ref="TimerT4" requirement="readWrite"/>
|
||
<parameter ref="TimerA" requirement="readWrite"/>
|
||
<parameter ref="TimerB" requirement="readWrite"/>
|
||
<parameter ref="TimerC" requirement="readWrite"/>
|
||
<parameter ref="TimerD" requirement="readWrite"/>
|
||
<parameter ref="TimerE" requirement="readWrite"/>
|
||
<parameter ref="TimerF" requirement="readWrite"/>
|
||
<parameter ref="TimerG" requirement="readWrite"/>
|
||
<parameter ref="TimerH" requirement="readWrite"/>
|
||
<parameter ref="TimerI" requirement="readWrite"/>
|
||
<parameter ref="TimerJ" requirement="readWrite"/>
|
||
<parameter ref="TimerK" requirement="readWrite"/>
|
||
<parameter ref="InviteExpires" requirement="readWrite"/>
|
||
<parameter ref="ReInviteExpires" requirement="readWrite"/>
|
||
<parameter ref="RegisterExpires" requirement="readWrite"/>
|
||
<parameter ref="RegisterRetryInterval" requirement="readWrite"/>
|
||
<parameter ref="InboundAuth" requirement="readWrite"/>
|
||
<parameter ref="InboundAuthUsername" requirement="readWrite"/>
|
||
<parameter ref="InboundAuthPassword" requirement="readWrite"/>
|
||
<parameter ref="UseCodecPriorityInSDPResponse" requirement="readWrite"/>
|
||
<parameter ref="DSCPMark" requirement="readWrite"/>
|
||
<parameter ref="VLANIDMark" requirement="readWrite"/>
|
||
<parameter ref="EthernetPriorityMark" requirement="readWrite"/>
|
||
<parameter ref="ConferenceCallDomainURI" requirement="readWrite"/>
|
||
<parameter ref="TimerLoginRejected" requirement="readWrite"/>
|
||
<parameter ref="NoLoginRetry" requirement="readWrite"/>
|
||
<parameter ref="TimerRegistrationFailed" requirement="readWrite"/>
|
||
<parameter ref="TimerSubscriptionFailed" requirement="readWrite"/>
|
||
<parameter ref="UnansweredRegistrationAttempts" requirement="readOnly"/>
|
||
<parameter ref="CodecList" requirement="readWrite"/>
|
||
<parameter ref="ResponseMapNumberOfEntries" requirement="readOnly"/>
|
||
</object>
|
||
<object ref="VoiceService.{i}.SIP.Network.{i}.ResponseMap.{i}." requirement="present">
|
||
<parameter ref="SIPResponseNumber" requirement="readWrite"/>
|
||
<parameter ref="Enable" requirement="readWrite"/>
|
||
<parameter ref="TextMessage" requirement="readWrite"/>
|
||
<parameter ref="Tone" requirement="readWrite"/>
|
||
</object>
|
||
</profile>
|
||
<profile name="SIPRegistrar:1" extends="VoIPProfile:1" version="2.0">
|
||
<object ref="VoiceService.{i}.Capabilities.SIP.Registrar." requirement="present">
|
||
<parameter ref="Extensions" requirement="readOnly"/>
|
||
<parameter ref="URISchemes" requirement="readOnly"/>
|
||
<parameter ref="EventTypes" requirement="readOnly"/>
|
||
<parameter ref="TLSAuthenticationProtocols" requirement="readOnly"/>
|
||
<parameter ref="TLSAuthenticationKeySizes" requirement="readOnly"/>
|
||
<parameter ref="TLSEncryptionProtocols" requirement="readOnly"/>
|
||
<parameter ref="TLSEncryptionKeySizes" requirement="readOnly"/>
|
||
<parameter ref="TLSKeyExchangeProtocols" requirement="readOnly"/>
|
||
</object>
|
||
<object ref="VoiceService.{i}.SIP." requirement="present">
|
||
<parameter ref="RegistrarNumberOfEntries" requirement="readOnly"/>
|
||
</object>
|
||
<object ref="VoiceService.{i}.SIP.Registrar.{i}." requirement="createDelete">
|
||
<parameter ref="Enable" requirement="readWrite"/>
|
||
<parameter ref="Status" requirement="readOnly"/>
|
||
<parameter ref="Alias" requirement="readWrite"/>
|
||
<parameter ref="Origin" requirement="readOnly"/>
|
||
<parameter ref="RegistrarIPAddress" requirement="readWrite"/>
|
||
<parameter ref="RegistrarPort" requirement="readWrite"/>
|
||
<parameter ref="RegisterExpires" requirement="readWrite"/>
|
||
<parameter ref="Organization" requirement="readWrite"/>
|
||
<parameter ref="Realm" requirement="readWrite"/>
|
||
<parameter ref="VoIPProfile" requirement="readWrite"/>
|
||
<parameter ref="ContactURI" requirement="readOnly"/>
|
||
<parameter ref="AccountNumberOfEntries" requirement="readOnly"/>
|
||
</object>
|
||
<object ref="VoiceService.{i}.SIP.Registrar.{i}.Account.{i}." requirement="createDelete">
|
||
<parameter ref="Enable" requirement="readWrite"/>
|
||
<parameter ref="Status" requirement="readOnly"/>
|
||
<parameter ref="Alias" requirement="readWrite"/>
|
||
<parameter ref="Origin" requirement="readOnly"/>
|
||
<parameter ref="AuthUserName" requirement="readWrite"/>
|
||
<parameter ref="AuthPassword" requirement="readWrite"/>
|
||
<parameter ref="RegistrationStatus" requirement="readOnly"/>
|
||
<parameter ref="URI" requirement="readWrite"/>
|
||
<parameter ref="Domain" requirement="readWrite"/>
|
||
<parameter ref="CodecList" requirement="readWrite"/>
|
||
<parameter ref="VoIPProfile" requirement="readWrite"/>
|
||
<parameter ref="ContactNumberOfEntries" requirement="readOnly"/>
|
||
</object>
|
||
<object ref="VoiceService.{i}.SIP.Registrar.{i}.Account.{i}.Contact.{i}." requirement="createDelete">
|
||
<parameter ref="Enable" requirement="readWrite"/>
|
||
<parameter ref="Status" requirement="readOnly"/>
|
||
<parameter ref="Alias" requirement="readWrite"/>
|
||
<parameter ref="Origin" requirement="readOnly"/>
|
||
<parameter ref="IPAddress" requirement="readWrite"/>
|
||
<parameter ref="Port" requirement="readWrite"/>
|
||
<parameter ref="ContactURI" requirement="readWrite"/>
|
||
<parameter ref="ExpireTime" requirement="readOnly"/>
|
||
<parameter ref="UserAgent" requirement="readWrite"/>
|
||
</object>
|
||
</profile>
|
||
<profile name="SIPProxy:1" extends="VoIPProfile:1" version="2.0">
|
||
<object ref="VoiceService.{i}.SIP." requirement="present">
|
||
<parameter ref="ProxyNumberOfEntries" requirement="readOnly"/>
|
||
</object>
|
||
<object ref="VoiceService.{i}.SIP.Proxy.{i}." requirement="createDelete">
|
||
<parameter ref="Enable" requirement="readWrite"/>
|
||
<parameter ref="Status" requirement="readOnly"/>
|
||
<parameter ref="Alias" requirement="readWrite"/>
|
||
<parameter ref="Origin" requirement="readOnly"/>
|
||
<parameter ref="ProxyIPAddress" requirement="readWrite"/>
|
||
<parameter ref="ProxyPort" requirement="readWrite"/>
|
||
<parameter ref="ContactURI" requirement="readOnly"/>
|
||
<parameter ref="VoIPProfile" requirement="readWrite"/>
|
||
</object>
|
||
</profile>
|
||
<profile name="H323:1" extends="VoIPProfile:1" version="2.0">
|
||
<object ref="VoiceService.{i}.Capabilities.H323." requirement="present">
|
||
<parameter ref="FastStart" requirement="readOnly"/>
|
||
<parameter ref="H235AuthenticationMethods" requirement="readOnly"/>
|
||
</object>
|
||
<object ref="VoiceService.{i}.H323." requirement="present">
|
||
<parameter ref="ClientNumberOfEntries" requirement="readOnly"/>
|
||
<parameter ref="NetworkNumberOfEntries" requirement="readOnly"/>
|
||
</object>
|
||
<object ref="VoiceService.{i}.H323.Client.{i}." requirement="createDelete">
|
||
<parameter ref="Enable" requirement="readWrite"/>
|
||
<parameter ref="Status" requirement="readOnly"/>
|
||
<parameter ref="H235Authentication" requirement="readWrite"/>
|
||
<parameter ref="AuthPassword" requirement="readWrite"/>
|
||
<parameter ref="SendersID" requirement="readWrite"/>
|
||
<parameter ref="Network" requirement="readWrite"/>
|
||
</object>
|
||
<object ref="VoiceService.{i}.H323.Network.{i}." requirement="createDelete">
|
||
<parameter ref="Gatekeeper" requirement="readWrite"/>
|
||
<parameter ref="GatekeeperPort" requirement="readWrite"/>
|
||
<parameter ref="GatekeeperID" requirement="readWrite"/>
|
||
<parameter ref="TimeToLive" requirement="readWrite"/>
|
||
<parameter ref="DSCPMark" requirement="readWrite"/>
|
||
<parameter ref="VLANIDMark" requirement="readWrite"/>
|
||
<parameter ref="EthernetPriorityMark" requirement="readWrite"/>
|
||
<parameter ref="STUNEnable" requirement="readWrite"/>
|
||
<parameter ref="STUNServer" requirement="readWrite"/>
|
||
<parameter ref="NonVoiceBandwidthReservedUpstream" requirement="readWrite"/>
|
||
<parameter ref="NonVoiceBandwidthReservedDownstream" requirement="readWrite"/>
|
||
<parameter ref="CodecList" requirement="readWrite"/>
|
||
</object>
|
||
</profile>
|
||
<profile name="MGCP:1" extends="VoIPProfile:1" version="2.0">
|
||
<object ref="VoiceService.{i}.Capabilities.MGCP." requirement="present">
|
||
<parameter ref="Extensions" requirement="readOnly"/>
|
||
</object>
|
||
<object ref="VoiceService.{i}.MGCP." requirement="present">
|
||
<parameter ref="ClientNumberOfEntries" requirement="readOnly"/>
|
||
<parameter ref="NetworkNumberOfEntries" requirement="readOnly"/>
|
||
</object>
|
||
<object ref="VoiceService.{i}.MGCP.Client.{i}." requirement="createDelete">
|
||
<parameter ref="Enable" requirement="readWrite"/>
|
||
<parameter ref="Status" requirement="readOnly"/>
|
||
<parameter ref="RegisterMode" requirement="readWrite"/>
|
||
<parameter ref="LocalPort" requirement="readWrite"/>
|
||
<parameter ref="Domain" requirement="readWrite"/>
|
||
<parameter ref="User" requirement="readWrite"/>
|
||
<parameter ref="Network" requirement="readWrite"/>
|
||
</object>
|
||
<object ref="VoiceService.{i}.MGCP.Network.{i}." requirement="createDelete">
|
||
<parameter ref="CallAgent1" requirement="readWrite"/>
|
||
<parameter ref="CallAgentPort1" requirement="readWrite"/>
|
||
<parameter ref="CallAgent2" requirement="readWrite"/>
|
||
<parameter ref="CallAgentPort2" requirement="readWrite"/>
|
||
<parameter ref="RetranIntervalTimer" requirement="readWrite"/>
|
||
<parameter ref="MaxRetranCount" requirement="readWrite"/>
|
||
<parameter ref="DSCPMark" requirement="readWrite"/>
|
||
<parameter ref="VLANIDMark" requirement="readWrite"/>
|
||
<parameter ref="EthernetPriorityMark" requirement="readWrite"/>
|
||
<parameter ref="AllowPiggybackEvents" requirement="readWrite"/>
|
||
<parameter ref="SendRSIPImmediately" requirement="readWrite"/>
|
||
<parameter ref="STUNEnable" requirement="readWrite"/>
|
||
<parameter ref="STUNServer" requirement="readWrite"/>
|
||
<parameter ref="NonVoiceBandwidthReservedUpstream" requirement="readWrite"/>
|
||
<parameter ref="NonVoiceBandwidthReservedDownstream" requirement="readWrite"/>
|
||
<parameter ref="CodecList" requirement="readWrite"/>
|
||
</object>
|
||
</profile>
|
||
<profile name="CallControl:1" version="2.0">
|
||
<object ref="VoiceService.{i}." requirement="present">
|
||
<parameter ref="CallLogNumberOfEntries" requirement="readOnly"/>
|
||
</object>
|
||
<object ref="VoiceService.{i}.Capabilities." requirement="present">
|
||
<parameter ref="MaxLineCount" requirement="readOnly"/>
|
||
<parameter ref="MaxSessionsPerLine" requirement="readOnly"/>
|
||
<parameter ref="MaxSessionsPerExtension" requirement="readOnly"/>
|
||
<parameter ref="MaxSessionCount" requirement="readOnly"/>
|
||
</object>
|
||
<object ref="VoiceService.{i}.CallControl." requirement="present">
|
||
<parameter ref="LineNumberOfEntries" requirement="readOnly"/>
|
||
<parameter ref="ExtensionNumberOfEntries" requirement="readOnly"/>
|
||
<parameter ref="IncomingMapNumberOfEntries" requirement="readOnly"/>
|
||
<parameter ref="OutgoingMapNumberOfEntries" requirement="readOnly"/>
|
||
<parameter ref="NumberingPlanNumberOfEntries" requirement="readOnly"/>
|
||
</object>
|
||
<object ref="VoiceService.{i}.CallControl.Line.{i}." requirement="createDelete">
|
||
<parameter ref="Enable" requirement="readWrite"/>
|
||
<parameter ref="Status" requirement="readOnly"/>
|
||
<parameter ref="Alias" requirement="readWrite"/>
|
||
<parameter ref="CallStatus" requirement="readOnly"/>
|
||
<parameter ref="Origin" requirement="readOnly"/>
|
||
<parameter ref="DirectoryNumber" requirement="readWrite"/>
|
||
<parameter ref="Provider" requirement="readWrite"/>
|
||
</object>
|
||
<object ref="VoiceService.{i}.CallControl.Line.{i}.Stats." requirement="present"/>
|
||
<object ref="VoiceService.{i}.CallControl.Line.{i}.Stats.IncomingCalls." requirement="present">
|
||
<parameter ref="CallsReceived" requirement="readOnly"/>
|
||
<parameter ref="CallsConnected" requirement="readOnly"/>
|
||
<parameter ref="CallsFailed" requirement="readOnly"/>
|
||
<parameter ref="CallsDropped" requirement="readOnly"/>
|
||
<parameter ref="TotalCallTime" requirement="readOnly"/>
|
||
</object>
|
||
<object ref="VoiceService.{i}.CallControl.Line.{i}.Stats.OutgoingCalls." requirement="present">
|
||
<parameter ref="CallsAttempted" requirement="readOnly"/>
|
||
<parameter ref="CallsConnected" requirement="readOnly"/>
|
||
<parameter ref="CallsFailed" requirement="readOnly"/>
|
||
<parameter ref="CallsDropped" requirement="readOnly"/>
|
||
<parameter ref="TotalCallTime" requirement="readOnly"/>
|
||
</object>
|
||
<object ref="VoiceService.{i}.CallControl.Line.{i}.Stats.RTP." requirement="present">
|
||
<parameter ref="PacketsReceived" requirement="readOnly"/>
|
||
<parameter ref="PacketsSent" requirement="readOnly"/>
|
||
<parameter ref="PacketsLost" requirement="readOnly"/>
|
||
<parameter ref="BytesSent" requirement="readOnly"/>
|
||
<parameter ref="BytesReceived" requirement="readOnly"/>
|
||
</object>
|
||
<object ref="VoiceService.{i}.CallControl.Line.{i}.Stats.DSP." requirement="present">
|
||
<parameter ref="Overruns" requirement="readOnly"/>
|
||
<parameter ref="Underruns" requirement="readOnly"/>
|
||
</object>
|
||
<object ref="VoiceService.{i}.CallControl.Extension.{i}." requirement="createDelete">
|
||
<parameter ref="Enable" requirement="readWrite"/>
|
||
<parameter ref="Status" requirement="readOnly"/>
|
||
<parameter ref="Alias" requirement="readWrite"/>
|
||
<parameter ref="CallStatus" requirement="readOnly"/>
|
||
<parameter ref="Origin" requirement="readOnly"/>
|
||
<parameter ref="ExtensionNumber" requirement="readWrite"/>
|
||
<parameter ref="Provider" requirement="readWrite"/>
|
||
</object>
|
||
<object ref="VoiceService.{i}.CallControl.Extension.{i}.Stats." requirement="present"/>
|
||
<object ref="VoiceService.{i}.CallControl.Extension.{i}.Stats.IncomingCalls." requirement="present">
|
||
<parameter ref="CallsReceived" requirement="readOnly"/>
|
||
<parameter ref="CallsConnected" requirement="readOnly"/>
|
||
<parameter ref="CallsFailed" requirement="readOnly"/>
|
||
<parameter ref="CallsDropped" requirement="readOnly"/>
|
||
<parameter ref="TotalCallTime" requirement="readOnly"/>
|
||
</object>
|
||
<object ref="VoiceService.{i}.CallControl.Extension.{i}.Stats.OutgoingCalls." requirement="present">
|
||
<parameter ref="CallsAttempted" requirement="readOnly"/>
|
||
<parameter ref="CallsConnected" requirement="readOnly"/>
|
||
<parameter ref="CallsFailed" requirement="readOnly"/>
|
||
<parameter ref="CallsDropped" requirement="readOnly"/>
|
||
<parameter ref="TotalCallTime" requirement="readOnly"/>
|
||
</object>
|
||
<object ref="VoiceService.{i}.CallControl.Extension.{i}.Stats.RTP." requirement="present">
|
||
<parameter ref="PacketsReceived" requirement="readOnly"/>
|
||
<parameter ref="PacketsSent" requirement="readOnly"/>
|
||
<parameter ref="PacketsLost" requirement="readOnly"/>
|
||
<parameter ref="BytesSent" requirement="readOnly"/>
|
||
<parameter ref="BytesReceived" requirement="readOnly"/>
|
||
</object>
|
||
<object ref="VoiceService.{i}.CallControl.Extension.{i}.Stats.DSP." requirement="present">
|
||
<parameter ref="Overruns" requirement="readOnly"/>
|
||
<parameter ref="Underruns" requirement="readOnly"/>
|
||
</object>
|
||
<object ref="VoiceService.{i}.CallControl.IncomingMap.{i}." requirement="createDelete">
|
||
<parameter ref="Enable" requirement="readWrite"/>
|
||
<parameter ref="Line" requirement="readWrite"/>
|
||
<parameter ref="Extension" requirement="readWrite"/>
|
||
<parameter ref="Order" requirement="readWrite"/>
|
||
<parameter ref="Timeout" requirement="readWrite"/>
|
||
</object>
|
||
<object ref="VoiceService.{i}.CallControl.OutgoingMap.{i}." requirement="createDelete">
|
||
<parameter ref="Enable" requirement="readWrite"/>
|
||
<parameter ref="CLIPNoScreeningNumber" requirement="readWrite"/>
|
||
<parameter ref="Extension" requirement="readWrite"/>
|
||
<parameter ref="Line" requirement="readWrite"/>
|
||
<parameter ref="Order" requirement="readWrite"/>
|
||
</object>
|
||
<object ref="VoiceService.{i}.CallLog.{i}." requirement="present">
|
||
<parameter ref="CallingPartyNumber" requirement="readOnly"/>
|
||
<parameter ref="CalledPartyNumber" requirement="readOnly"/>
|
||
<parameter ref="Source" requirement="readOnly"/>
|
||
<parameter ref="Destination" requirement="readOnly"/>
|
||
<parameter ref="RemoteParty" requirement="readOnly"/>
|
||
<parameter ref="UsedLine" requirement="readOnly"/>
|
||
<parameter ref="UsedExtensions" requirement="readOnly"/>
|
||
<parameter ref="Direction" requirement="readOnly"/>
|
||
<parameter ref="Start" requirement="readOnly"/>
|
||
<parameter ref="Duration" requirement="readOnly"/>
|
||
<parameter ref="CallTerminationCause" requirement="readOnly"/>
|
||
</object>
|
||
</profile>
|
||
<profile name="CallingFeatures:1" extends="CallControl:1" version="2.0">
|
||
<object ref="VoiceService.{i}.CallControl.CallingFeatures." requirement="present">
|
||
<parameter ref="SetNumberOfEntries" requirement="readOnly"/>
|
||
</object>
|
||
<object ref="VoiceService.{i}.CallControl.CallingFeatures.Set.{i}." requirement="createDelete">
|
||
<parameter ref="CallerIDEnable" requirement="readWrite"/>
|
||
<parameter ref="CallerIDNameEnable" requirement="readWrite"/>
|
||
<parameter ref="CallForwardUnconditionalEnable" requirement="readWrite"/>
|
||
<parameter ref="CallForwardUnconditionalNumber" requirement="readWrite"/>
|
||
<parameter ref="CallForwardOnBusyEnable" requirement="readWrite"/>
|
||
<parameter ref="CallForwardOnBusyNumber" requirement="readWrite"/>
|
||
<parameter ref="CallForwardOnBusyRingTimeout" requirement="readWrite"/>
|
||
<parameter ref="CallForwardOnNoAnswerEnable" requirement="readWrite"/>
|
||
<parameter ref="CallForwardOnNoAnswerNumber" requirement="readWrite"/>
|
||
<parameter ref="CallForwardOnNoAnswerRingTimeout" requirement="readWrite"/>
|
||
<parameter ref="MWIEnable" requirement="readWrite"/>
|
||
<parameter ref="AnonymousCallRejectionEnable" requirement="readWrite"/>
|
||
<parameter ref="AnonymousCallEnable" requirement="readWrite"/>
|
||
<parameter ref="IIFCEnable" requirement="readWrite"/>
|
||
</object>
|
||
</profile>
|
||
<profile name="Interwork:1" version="2.0">
|
||
<object ref="VoiceService.{i}." requirement="present">
|
||
<parameter ref="InterworkNumberOfEntries" requirement="readOnly"/>
|
||
</object>
|
||
<object ref="VoiceService.{i}.Interwork.{i}." requirement="createDelete">
|
||
<parameter ref="Enable" requirement="readWrite"/>
|
||
<parameter ref="Status" requirement="readOnly"/>
|
||
<parameter ref="Alias" requirement="readWrite"/>
|
||
<parameter ref="NetworkConnectionMode" requirement="readWrite"/>
|
||
<parameter ref="UserConnectionMode" requirement="readWrite"/>
|
||
<parameter ref="E164Mode" requirement="readWrite"/>
|
||
<parameter ref="NetworkIPAddress" requirement="readOnly"/>
|
||
<parameter ref="ProxyServer" requirement="readWrite"/>
|
||
<parameter ref="Networks" requirement="readWrite"/>
|
||
<parameter ref="E164Client" requirement="readWrite"/>
|
||
<parameter ref="UserInterfaceNumberOfEntries" requirement="readOnly"/>
|
||
<parameter ref="MapNumberOfEntries" requirement="readOnly"/>
|
||
</object>
|
||
<object ref="VoiceService.{i}.Interwork.{i}.UserInterface.{i}." requirement="createDelete">
|
||
<parameter ref="Enable" requirement="readWrite"/>
|
||
<parameter ref="Alias" requirement="readWrite"/>
|
||
<parameter ref="Registrar" requirement="readWrite"/>
|
||
<parameter ref="Network" requirement="readWrite"/>
|
||
</object>
|
||
<object ref="VoiceService.{i}.Interwork.{i}.Map.{i}." requirement="createDelete">
|
||
<parameter ref="Enable" requirement="readWrite"/>
|
||
<parameter ref="Status" requirement="readOnly"/>
|
||
<parameter ref="Alias" requirement="readWrite"/>
|
||
<parameter ref="Origin" requirement="readOnly"/>
|
||
<parameter ref="NetworkConnection" requirement="readWrite"/>
|
||
<parameter ref="UserConnection" requirement="readWrite"/>
|
||
<parameter ref="DigitMap" requirement="readWrite"/>
|
||
<parameter ref="DigitMapEnable" requirement="readWrite"/>
|
||
<parameter ref="Priority" requirement="readWrite"/>
|
||
</object>
|
||
</profile>
|
||
<profile name="Trunk:1" version="2.0">
|
||
<object ref="VoiceService.{i}." requirement="present">
|
||
<parameter ref="TrunkNumberOfEntries" requirement="readOnly"/>
|
||
</object>
|
||
<object ref="VoiceService.{i}.Trunk.{i}." requirement="createDelete">
|
||
<parameter ref="Name" requirement="readWrite"/>
|
||
<parameter ref="Enable" requirement="readWrite"/>
|
||
<parameter ref="Status" requirement="readOnly"/>
|
||
<parameter ref="DDIRange" requirement="readWrite"/>
|
||
<parameter ref="LineObjectCreation" requirement="readWrite"/>
|
||
<parameter ref="MaxOutboundChannelCount" requirement="readOnly"/>
|
||
<parameter ref="MaxInboundChannelCount" requirement="readOnly"/>
|
||
<parameter ref="MaxChannels" requirement="readWrite"/>
|
||
<parameter ref="CodecPriority" requirement="readWrite"/>
|
||
<parameter ref="Provider" requirement="readWrite"/>
|
||
</object>
|
||
</profile>
|
||
<profile name="Terminal:1" version="2.0">
|
||
<object ref="VoiceService.{i}." requirement="present">
|
||
<parameter ref="TerminalNumberOfEntries" requirement="readOnly"/>
|
||
</object>
|
||
<object ref="VoiceService.{i}.Terminal.{i}." requirement="present">
|
||
<parameter ref="Enable" requirement="readWrite"/>
|
||
<parameter ref="Status" requirement="readOnly"/>
|
||
<parameter ref="Alias" requirement="readWrite"/>
|
||
</object>
|
||
<object ref="VoiceService.{i}.Terminal.{i}.ButtonMap." requirement="present">
|
||
<parameter ref="ButtonNumberOfEntries" requirement="readOnly"/>
|
||
</object>
|
||
<object ref="VoiceService.{i}.Terminal.{i}.ButtonMap.Button.{i}." requirement="present">
|
||
<parameter ref="Alias" requirement="readWrite"/>
|
||
<parameter ref="ButtonName" requirement="readOnly"/>
|
||
<parameter ref="FacilityAction" requirement="readWrite"/>
|
||
<parameter ref="FacilityActionArgument" requirement="readWrite"/>
|
||
<parameter ref="QuickDialNumber" requirement="readWrite"/>
|
||
<parameter ref="ButtonMessage" requirement="readWrite"/>
|
||
<parameter ref="UserAccess" requirement="readWrite"/>
|
||
</object>
|
||
</profile>
|
||
<profile name="CallStatistics:1" version="2.0">
|
||
<object ref="VoiceService.{i}." requirement="present">
|
||
<parameter ref="CallLogNumberOfEntries" requirement="readOnly"/>
|
||
</object>
|
||
<object ref="VoiceService.{i}.CallLog.{i}." requirement="present">
|
||
<parameter ref="SessionNumberOfEntries" requirement="readOnly"/>
|
||
</object>
|
||
<object ref="VoiceService.{i}.CallLog.{i}.Session.{i}." requirement="present">
|
||
<parameter ref="StreamType" requirement="readOnly"/>
|
||
<parameter ref="Start" requirement="readOnly"/>
|
||
<parameter ref="Duration" requirement="readOnly"/>
|
||
<parameter ref="SessionID" requirement="readOnly"/>
|
||
</object>
|
||
<object ref="VoiceService.{i}.CallLog.{i}.Session.{i}.Source.RTP." requirement="present">
|
||
<parameter ref="FarEndIPAddress" requirement="readOnly"/>
|
||
<parameter ref="FarEndUDPPort" requirement="readOnly"/>
|
||
<parameter ref="LocalUDPPort" requirement="readOnly"/>
|
||
<parameter ref="MinJitter" requirement="readOnly"/>
|
||
<parameter ref="MaxJitter" requirement="readOnly"/>
|
||
<parameter ref="MeanJitter" requirement="readOnly"/>
|
||
<parameter ref="BufferDelay" requirement="readOnly"/>
|
||
<parameter ref="BurstCount" requirement="readOnly"/>
|
||
<parameter ref="PacketsReceived" requirement="readOnly"/>
|
||
<parameter ref="PacketsLost" requirement="readOnly"/>
|
||
<parameter ref="PacketsDiscarded" requirement="readOnly"/>
|
||
<parameter ref="ReceiveInterarrivalJitter" requirement="readOnly"/>
|
||
<parameter ref="AverageReceiveInterarrivalJitter" requirement="readOnly"/>
|
||
<parameter ref="RoundTripDelay" requirement="readOnly"/>
|
||
<parameter ref="AverageRoundTripDelay" requirement="readOnly"/>
|
||
</object>
|
||
<object ref="VoiceService.{i}.CallLog.{i}.Session.{i}.Source.DSP." requirement="present"/>
|
||
<object ref="VoiceService.{i}.CallLog.{i}.Session.{i}.Source.DSP.ReceiveCodec." requirement="present">
|
||
<parameter ref="Codec" requirement="readOnly"/>
|
||
<parameter ref="SilenceSuppression" requirement="readOnly"/>
|
||
<parameter ref="Overruns" requirement="readOnly"/>
|
||
<parameter ref="Underruns" requirement="readOnly"/>
|
||
</object>
|
||
<object ref="VoiceService.{i}.CallLog.{i}.Session.{i}.Source.DSP.TransmitCodec." requirement="present">
|
||
<parameter ref="Codec" requirement="readOnly"/>
|
||
<parameter ref="SilenceSuppression" requirement="readOnly"/>
|
||
<parameter ref="PacketizationPeriod" requirement="readOnly"/>
|
||
<parameter ref="Overruns" requirement="readOnly"/>
|
||
<parameter ref="Underruns" requirement="readOnly"/>
|
||
</object>
|
||
<object ref="VoiceService.{i}.CallLog.{i}.Session.{i}.Source.VoiceQuality." requirement="present">
|
||
<parameter ref="VoIPQualityIndicator" requirement="readOnly"/>
|
||
<parameter ref="WorstVoIPQualityIndicatorsValues" requirement="readOnly"/>
|
||
<parameter ref="WorstVoIPQualityIndicatorTimestamps" requirement="readOnly"/>
|
||
</object>
|
||
<object ref="VoiceService.{i}.CallLog.{i}.Session.{i}.Destination.RTP." requirement="present">
|
||
<parameter ref="FarEndIPAddress" requirement="readOnly"/>
|
||
<parameter ref="FarEndUDPPort" requirement="readOnly"/>
|
||
<parameter ref="LocalUDPPort" requirement="readOnly"/>
|
||
<parameter ref="MinJitter" requirement="readOnly"/>
|
||
<parameter ref="MaxJitter" requirement="readOnly"/>
|
||
<parameter ref="MeanJitter" requirement="readOnly"/>
|
||
<parameter ref="BufferDelay" requirement="readOnly"/>
|
||
<parameter ref="BurstCount" requirement="readOnly"/>
|
||
<parameter ref="PacketsReceived" requirement="readOnly"/>
|
||
<parameter ref="PacketsLost" requirement="readOnly"/>
|
||
<parameter ref="PacketsDiscarded" requirement="readOnly"/>
|
||
<parameter ref="ReceiveInterarrivalJitter" requirement="readOnly"/>
|
||
<parameter ref="AverageReceiveInterarrivalJitter" requirement="readOnly"/>
|
||
<parameter ref="RoundTripDelay" requirement="readOnly"/>
|
||
<parameter ref="AverageRoundTripDelay" requirement="readOnly"/>
|
||
</object>
|
||
<object ref="VoiceService.{i}.CallLog.{i}.Session.{i}.Destination.DSP." requirement="present"/>
|
||
<object ref="VoiceService.{i}.CallLog.{i}.Session.{i}.Destination.DSP.ReceiveCodec." requirement="present">
|
||
<parameter ref="Codec" requirement="readOnly"/>
|
||
<parameter ref="SilenceSuppression" requirement="readOnly"/>
|
||
<parameter ref="Overruns" requirement="readOnly"/>
|
||
<parameter ref="Underruns" requirement="readOnly"/>
|
||
</object>
|
||
<object ref="VoiceService.{i}.CallLog.{i}.Session.{i}.Destination.DSP.TransmitCodec." requirement="present">
|
||
<parameter ref="Codec" requirement="readOnly"/>
|
||
<parameter ref="SilenceSuppression" requirement="readOnly"/>
|
||
<parameter ref="PacketizationPeriod" requirement="readOnly"/>
|
||
<parameter ref="Overruns" requirement="readOnly"/>
|
||
<parameter ref="Underruns" requirement="readOnly"/>
|
||
</object>
|
||
<object ref="VoiceService.{i}.CallLog.{i}.Session.{i}.Destination.VoiceQuality." requirement="present">
|
||
<parameter ref="VoIPQualityIndicator" requirement="readOnly"/>
|
||
<parameter ref="WorstVoIPQualityIndicatorsValues" requirement="readOnly"/>
|
||
<parameter ref="WorstVoIPQualityIndicatorTimestamps" requirement="readOnly"/>
|
||
</object>
|
||
</profile>
|
||
<profile name="ClockSynchronization:1" version="2.0">
|
||
<object ref="VoiceService.{i}.ClockSynchronization." requirement="present">
|
||
<parameter ref="ClockSourceNumberOfEntries" requirement="readOnly"/>
|
||
<parameter ref="CurrentSource" requirement="readWrite"/>
|
||
<parameter ref="Description" requirement="readOnly"/>
|
||
<parameter ref="AutoRevert" requirement="readWrite"/>
|
||
</object>
|
||
<object ref="VoiceService.{i}.ClockSynchronization.ClockSource.{i}." requirement="present">
|
||
<parameter ref="Enable" requirement="readWrite"/>
|
||
<parameter ref="Order" requirement="readWrite"/>
|
||
<parameter ref="Interface" requirement="readWrite"/>
|
||
</object>
|
||
</profile>
|
||
</model>
|
||
</dm:document>
|