blob: 5d1d678168326a4bdfbef273d6cb8aed4de1b587 [file] [log] [blame]
<?xml version="1.0" encoding="UTF-8"?>
<!--
TR-181 catawampus.org vendor extension
-->
<dm:document xmlns:dm="urn:broadband-forum-org:cwmp:datamodel-1-3"
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-3 cwmp-datamodel-1-3.xsd
urn:broadband-forum-org:cwmp:datamodel-report-0-1 cwmp-datamodel-report.xsd"
spec="urn:catawampus-org:x-catawampus-tr098-1-0">
<description>InternetGatewayDevice data model (Catawampus additions).</description>
<import file="tr-098-1-6.xml" spec="urn:broadband-forum-org:tr-098-1-6">
<model name="InternetGatewayDevice:1.12"/>
</import>
<model name="X_CATAWAMPUS-ORG_InternetGatewayDevice:1.0" base="InternetGatewayDevice:1.12">
<object base="InternetGatewayDevice.LANDevice.{i}.WLANConfiguration.{i}." access="readOnly" numEntriesParameter="LANWLANConfigurationNumberOfEntries" minEntries="0" maxEntries="unbounded">
<parameter name="SupportedFrequencyBands" access="readOnly">
<description>{{list}} List items indicate the frequency bands at which the radio can operate.</description>
<syntax>
<list/>
<string>
<enumeration value="2.4GHz"/>
<enumeration value="5GHz"/>
</string>
</syntax>
</parameter>
<parameter name="ClientEnable" access="readWrite">
<description>If set to True, causes the host to try to connect to the wireless network configured on an InternetGatewayDevice it knows about.</description>
<syntax>
<boolean />
</syntax>
</parameter>
<parameter name="GuardInterval" access="readWrite">
<description>The guard interval value between OFDM symbols (applicable to 802.11n specifications only).</description>
<syntax>
<string>
<enumeration value="400nsec"/>
<enumeration value="800nsec"/>
<enumeration value="Auto"/>
</string>
</syntax>
</parameter>
<parameter name="OperatingFrequencyBand" access="readWrite">
<description>Indicates the frequency band at which the radio is operating.
If the radio supports multiple bands, and {{param}} is changed, then all parameters whose value is not valid for the new frequency band (e.g. {{param|Channel}}) MUST be set to a valid value (according to some CPE vendor-specific behavior).</description>
<syntax>
<string>
<enumerationRef targetParam="SupportedFrequencyBands"/>
</string>
</syntax>
</parameter>
<parameter name="RekeyingInterval" access="readWrite">
<description>The interval (expressed in {{units}}) in which the keys are re-generated.
This is applicable to WPA, WPA2 and Mixed (WPA-WPA2) modes in Personal or Enterprise mode (i.e. when {{param|ModeEnabled}} is set to a value other than {{enum|None|ModeEnabled}} or {{enum|WEP-64|ModeEnabled}} or {{enum|WEP-128|ModeEnabled}}.</description>
<syntax>
<unsignedInt>
<units value="seconds"/>
</unsignedInt>
<default type="object" value="3600"/>
</syntax>
</parameter>
<parameter name="SupportedStandards" access="readOnly">
<description>{{list}} List items indicate which IEEE 802.11 standards this {{object}} instance can support simultaneously, in the frequency band specified by {{param|OperatingFrequencyBand}}. {{enum}}
Each value indicates support for the indicated standard.
If {{param|OperatingFrequencyBand}} is set to {{enum|2.4GHz|OperatingFrequencyBand}}, only values {{enum|b}}, {{enum|g}}, {{enum|n}} are allowed.
If {{param|OperatingFrequencyBand}} is set to {{enum|5GHz|OperatingFrequencyBand}}, only values {{enum|a}}, {{enum|n}} are allowed.</description>
<syntax>
<list/>
<string>
<enumeration value="a">
<description>{{bibref|802.11a-1999}}</description>
</enumeration>
<enumeration value="b">
<description>{{bibref|802.11b-1999}}</description>
</enumeration>
<enumeration value="g">
<description>{{bibref|802.11g-2003}}</description>
</enumeration>
<enumeration value="n">
<description>{{bibref|802.11n-2009}}</description>
</enumeration>
</string>
</syntax>
</parameter>
<parameter name="OperatingStandards" access="readWrite">
<description>{{list}} List items indicate which IEEE 802.11 standard this {{object}} instance is configured for.
Each value indicates support for the indicated standard.
If {{param|OperatingFrequencyBand}} is set to {{enum|2.4GHz|OperatingFrequencyBand}}, only values {{enum|b}}, {{enum|g}}, {{enum|n}} are allowed.
If {{param|OperatingFrequencyBand}} is set to {{enum|5GHz|OperatingFrequencyBand}}, only values {{enum|a}}, {{enum|n}} are allowed.
For example, a value of "g,b" (or "b,g" - order is not important) means that the 802.11g standard {{bibref|802.11g-2003}} is used with a backwards-compatible mode for 802.11b {{bibref|802.11b-1999}}. A value of "g" means that only the 802.11g standard can be used.</description>
<syntax>
<list/>
<string>
<enumerationRef targetParam="SupportedStandards"/>
</string>
</syntax>
</parameter>
<parameter name="X_CATAWAMPUS-ORG_Width24G" access="readWrite" activeNotify="canDeny">
<description>The requested channel width when using 2.4 GHz channels.</description>
<string>
<enumeration value=""/>
<enumeration value="20"/>
<enumeration value="40"/>
</string>
</parameter>
<parameter name="X_CATAWAMPUS-ORG_Width5G" access="readWrite" activeNotify="canDeny">
<description>The requested channel width when using 5 GHz channels.</description>
<string>
<enumeration value=""/>
<enumeration value="20"/>
<enumeration value="40"/>
<enumeration value="80"/>
</string>
</parameter>
<parameter name="X_CATAWAMPUS-ORG_AutoChanType" access="readWrite" activeNotify="canDeny">
<description>The AutoChannel algorithm to use, for example NONDFS or HIGH.</description>
<syntax>
<string/>
</syntax>
</parameter>
<parameter name="X_CATAWAMPUS-ORG_AllowAutoDisable" access="readWrite">
<description>If AutoDisableRecommended is non-empty, CPE disables the interface and Status goes to Down (but Enabled and RadioEnabled are not modified).</description>
<syntax>
<boolean/>
</syntax>
</parameter>
<parameter name="X_CATAWAMPUS-ORG_AutoDisableRecommended" access="readOnly" activeNotify="canDeny">
<description>If the system recommends disabling this radio, this is set to true.</description>
<syntax>
<boolean/>
</syntax>
</parameter>
<parameter name="X_CATAWAMPUS-ORG_ClientIsolation" access="readWrite">
<description>If ClientIsolation is True, CPE will isolate clients on the network from each other.</description>
<syntax>
<boolean/>
</syntax>
</parameter>
<parameter name="X_CATAWAMPUS-ORG_AutoChannelAlgorithm" access="readWrite">
<description>If LEGACY, use old-style /bin/wifi autochannel recommendation. If INITIAL, use boot-time waveguide recommendation. If DYNAMIC, use real-time waveguide recommendation.</description>
<syntax>
<string>
<enumeration value="LEGACY"/>
<enumeration value="INITIAL"/>
<enumeration value="DYNAMIC"/>
</string>
</syntax>
</parameter>
<parameter name="X_CATAWAMPUS-ORG_RecommendedChannel" access="readOnly" activeNotify="canDeny">
<description>The waveguide-recommended channel frequency to use (most recent).</description>
<syntax>
<int>
<units value="MHz"/>
</int>
</syntax>
</parameter>
<parameter name="X_CATAWAMPUS-ORG_InitiallyRecommendedChannel" access="readOnly" activeNotify="canDeny">
<description>The waveguide-recommended channel frequency to use (boot time).</description>
<syntax>
<int>
<units value="MHz"/>
</int>
</syntax>
</parameter>
<parameter name="X_CATAWAMPUS-ORG_OverrideSSID" access="readWrite">
<description>Use this instead of the SSID provided by the ACS. Intended for use in experiments.</description>
<syntax>
<string/>
</syntax>
</parameter>
<parameter name="X_CATAWAMPUS-ORG_Suffix24G" access="readWrite">
<description>2.4GHz SSID suffix.</description>
<syntax>
<string/>
</syntax>
</parameter>
</object>
<object base="InternetGatewayDevice.LANDevice.{i}.WLANConfiguration.{i}.AssociatedDevice.{i}." access="readOnly" minEntries="0" maxEntries="unbounded" numEntriesParameter="TotalAssociations">
<parameter name="X_CATAWAMPUS-ORG_LastDataDownlinkRate" access="readOnly" activeNotify="canDeny">
<description>The data transmit rate in {{units}} that was most recently used for transmission from the access point to the associated device. (Taken from tr-181-2-0).</description>
<syntax>
<unsignedInt>
<range minInclusive="1000" maxInclusive="600000"/>
<units value="kbps"/>
</unsignedInt>
</syntax>
</parameter>
<parameter name="X_CATAWAMPUS-ORG_LastDataUplinkRate" access="readOnly" activeNotify="canDeny">
<description>The data transmit rate in {{units}} that was most recently used for transmission from the associated device to the access point. (Taken from tr-181-2-0).</description>
<syntax>
<unsignedInt>
<range minInclusive="1000" maxInclusive="600000"/>
<units value="kbps"/>
</unsignedInt>
</syntax>
</parameter>
<parameter name="X_CATAWAMPUS-ORG_Active" access="readOnly">
<description>Whether or not this node is currently present in the WiFi AccessPoint network.
The ability to list inactive nodes is OPTIONAL. If the CPE includes inactive nodes in this table, {{param}} MUST be set to {{false}} for each inactive node. The length of time an inactive node remains listed in this table is a local matter to the CPE. (Taken from tr-181-2-0).</description>
<syntax>
<boolean/>
</syntax>
</parameter>
<parameter name="X_CATAWAMPUS-ORG_SignalStrength" access="readOnly" activeNotify="canDeny">
<description>The received signal strength in {{units}} of the last received PPDU.</description>
<syntax>
<int>
<units value="dBm"/>
</int>
</syntax>
</parameter>
<parameter name="X_CATAWAMPUS-ORG_StationInfo" access="readOnly" activeNotify="canDeny">
<description>Station information reported by the wireless network driver.</description>
<syntax>
<string/>
</syntax>
</parameter>
<parameter name="X_CATAWAMPUS-ORG_SignalStrengthAverage" access="readOnly" activeNotify="canDeny">
<description>The received signal strength in {{units}} averaged over time.</description>
<syntax>
<int>
<units value="dBm"/>
</int>
</syntax>
</parameter>
</object>
</model>
</dm:document>