blob: ce8a00d43ebc86e55a1246c167ffbd11b88f9483 [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-tr181-2-0">
<description>Device:2.x data model (Catawampus additions).</description>
<import file="tr-181-2-6.xml" spec="urn:broadband-forum-org:tr-181-2-6">
<model name="Device:2.6"/>
</import>
<model name="X_CATAWAMPUS-ORG_Device:2.0" base="Device:2.6">
<object base="Device." access="readOnly" minEntries="1" maxEntries="1"/>
<object base="Device.DeviceInfo." access="readOnly" minEntries="1" maxEntries="1"/>
<object name="Device.DNS." access="readOnly" minEntries="1" maxEntries="1"/>
<object name="Device.DNS.Diagnostics." access="readOnly" minEntries="1" maxEntries="1">
<parameter name="X_CATAWAMPUS-ORG_ExtraCheckServers" access="readWrite" activeNotify="canDeny">
<description>A comma-delimited list of DNS servers to check.</description>
<syntax><string><size maxLength="8192"/></string></syntax>
</parameter>
</object>
<object name="Device.X_CATAWAMPUS-ORG." access="readOnly" minEntries="1" maxEntries="1"/>
<object name="Device.X_CATAWAMPUS-ORG.Catawampus." access="readOnly" minEntries="1" maxEntries="1">
<description>Support for debugging the catawampus daemon itself.</description>
<parameter name="RuntimeEnvInfo" access="readOnly">
<description>Information about the runtime environment, useful for debugging.</description>
<syntax>
<string>
<size maxLength="4096"/>
</string>
</syntax>
</parameter>
</object>
<object name="Device.X_CATAWAMPUS-ORG.Catawampus.Profiler." access="readOnly" minEntries="1" maxEntries="1">
<parameter name="Enable" access="readWrite">
<description>Enables profiling.</description>
<syntax><boolean/></syntax>
</parameter>
<parameter name="Result" access="readOnly">
<description>Current profiling result, updated when profiler is enabled and then disabled.</description>
<syntax><boolean/></syntax>
</parameter>
</object>
<object name="Device.X_CATAWAMPUS-ORG.Catawampus.ExpensiveStuff." access="readOnly" minEntries="1" maxEntries="1">
<parameter name="Enable" access="readWrite">
<description>Enables instrumentation of periodic stats which take a long time to
collect. Storing this data adds to the memory footprint, so it is not routinely
left on.</description>
<syntax><boolean/></syntax>
</parameter>
<parameter name="Stats" access="readOnly">
<description>Text description of the N most expensive PeriodicStatistics to sample.</description>
<syntax>
<string>
<size maxLength="131072"/>
</string>
</syntax>
</parameter>
<parameter name="Notifications" access="readOnly">
<description>Text description of the N most expensive Notifications to sample.</description>
<syntax>
<string>
<size maxLength="131072"/>
</string>
</syntax>
</parameter>
</object>
<object name="Device.X_CATAWAMPUS-ORG.DynamicDNS." access="readOnly" minEntries="1" maxEntries="1">
<parameter name="ServiceNumberOfEntries" access="readOnly">
<description>The number of instances of {{object|.X_CATAWAMPUS-ORG.DynamicDNS.Service.{i}.}}.</description>
<syntax>
<unsignedInt/>
</syntax>
</parameter>
</object>
<object base="Device.X_CATAWAMPUS-ORG.DynamicDNS.Service.{i}." access="readOnly" numEntriesParameter="ServiceNumberOfEntries" minEntries="0" maxEntries="unbounded" enableParameter="Enable">
<description>Each instance is a Dynamic DNS provider to update as the device Internet Address changes.</description>
<parameter name="Enable" access="readWrite">
<description>Enable this entry.</description>
<syntax><boolean/></syntax>
</parameter>
<parameter name="ServiceName" access="readWrite">
<description>The name of the Dynamic DNS service provider, for example:
dyndns@dyndns.org OR statdns@dyndns.org OR custom@dyndns.org
default@freedns.afraid.org
default@zoneedit.com
default@no-ip.com
</description>
<syntax><string><size maxLength="256"/></string></syntax>
</parameter>
<parameter name="ServiceURL" access="readWrite">
<description>The URL name of the Dynamic DNS service provider.</description>
<syntax><string/></syntax>
</parameter>
<parameter name="Status" access="readOnly">
<description>The status of this entry. {{enum}}
The {{enum|Misconfigured_NoServiceName}} value indicates that the ServiceName is undefined or invalid.
</description>
<syntax>
<string>
<enumeration value="Disabled"/>
<enumeration value="Enabled"/>
<enumeration value="Misconfigured_NoServiceName"/>
<enumeration value="Misconfigured_NoDomain"/>
</string>
<default type="object" value="Disabled"/>
</syntax>
</parameter>
<parameter name="Username" access="readWrite">
<description>The username to use when logging in.</description>
<syntax><string><size maxLength="256"/></string></syntax>
</parameter>
<parameter name="Password" access="readWrite">
<description>The password to use when logging in.</description>
<syntax><string><size maxLength="256"/></string></syntax>
</parameter>
<parameter name="Domain" access="readWrite">
<description>The name of the domain(s) to register with the Dynamic DNS service. Though it is expected that only a single domain will be present here, multiple domains can be specifyed by separating them with commas.</description>
<syntax><string><size maxLength="256"/></string></syntax>
</parameter>
<parameter name="UpdateFrequency" access="readOnly">
<description>How frequently to update the service, in in {{units}}.</description>
<syntax><unsignedInt><units value="minutes"/></unsignedInt></syntax>
</parameter>
</object>
<object name="Device.X_CATAWAMPUS-ORG.Bluetooth." access="readOnly" minEntries="1" maxEntries="1">
<parameter name="RemoteControlNumberOfEntries" access="readOnly">
<description>The number of instances of {{object|.RemoteControl.{i}.}}.</description>
<syntax>
<unsignedInt/>
</syntax>
</parameter>
<parameter name="UnplugGFRM100" access="readWrite">
<description>Writing True to this parameter will trigger the device to send Virtual Cable Unplug messages to all GFRM100 remote controls, the next time they connect.</description>
<syntax>
<boolean/>
</syntax>
</parameter>
</object>
<object name="Device.X_CATAWAMPUS-ORG.Bluetooth.RemoteControl.{i}." access="readOnly"
numEntriesParameter="RemoteControlNumberOfEntries" minEntries="0" maxEntries="unbounded">
<description>Information about remote controls paired with this device.</description>
<parameter name="PhysAddress" access="readOnly">
<description>Bluetooth address of the remote; this is a 6 byte MAC address.</description>
<syntax><string><size maxLength="32"/></string></syntax>
</parameter>
<parameter name="Model" access="readOnly">
<description>Model of the remote, like GFRM100 or GFRM200.</description>
<syntax><string><size maxLength="32"/></string></syntax>
</parameter>
<parameter name="SerialNumber" access="readOnly">
<description>Serial Number of the remote, if known.</description>
<syntax><string><size maxLength="64"/></string></syntax>
</parameter>
<parameter name="HardwareVersion" access="readOnly">
<description>Hardware Version of the remote, if known. This is generally a GPN (Google Part Number).</description>
<syntax><string><size maxLength="64"/></string></syntax>
</parameter>
<parameter name="FirmwareVersion" access="readOnly">
<description>Firmware Version of the remote, if known.</description>
<syntax><string><size maxLength="64"/></string></syntax>
</parameter>
</object>
<object base="Device.X_CATAWAMPUS-ORG.Bluetooth.iBeacon." access="readOnly" minEntries="1" maxEntries="1" enableParameter="Enable">
<parameter name="Enable" access="readWrite">
<description>Enables or disables the iBeacon.</description>
<syntax>
<boolean/>
</syntax>
</parameter>
<parameter name="UUID" access="readWrite">
<description>UUID to send in beacons.</description>
<syntax>
<string/>
</syntax>
</parameter>
<parameter name="Major" access="readWrite">
<description>Major number to send in beacons.</description>
<syntax>
<unsignedInt/>
</syntax>
</parameter>
<parameter name="Minor" access="readWrite">
<description>Minor number to send in beacons.</description>
<syntax>
<unsignedInt/>
</syntax>
</parameter>
<parameter name="TxPower" access="readWrite">
<description>Transmit power to populate in beacons. This is not the amount of TX Power to use, it is a field in the beacon which tells the recipient what power to expect to see at 1 meter distance from the device. This allows the recipient to calculate how far away the beacon must therefore be.</description>
<syntax>
<unsignedInt/>
</syntax>
</parameter>
</object>
<object base="Device.X_CATAWAMPUS-ORG.Bluetooth.Eddystone." access="readOnly" minEntries="1" maxEntries="1" enableParameter="Enable">
<parameter name="Enable" access="readWrite">
<description>Enables or disables Eddystone beacon advertisements.</description>
<syntax>
<boolean/>
</syntax>
</parameter>
<parameter name="Namespace" access="readWrite">
<description>Namespace ID to send in beacons. This should be a 10 byte hex string like '00112233445566778899'.</description>
<syntax>
<string/>
</syntax>
</parameter>
<parameter name="Instance" access="readWrite">
<description>Instance number to send in beacons. This should be a 6 byte hex string like 'aabbccddeeff'.</description>
<syntax>
<string/>
</syntax>
</parameter>
<parameter name="TxPower" access="readWrite">
<description>Transmit power to populate in beacons. This is not the amount of TX Power to use, it is a field in the beacon which tells the recipient what power to expect to see at 0 meters distance from the device. This allows the recipient to calculate how far away the beacon must therefore be.</description>
<syntax>
<unsignedInt/>
</syntax>
</parameter>
</object>
<object base="Device.Ethernet." access="readOnly" minEntries="1" maxEntries="1"/>
<object base="Device.Ethernet.Interface.{i}." access="readOnly" numEntriesParameter="InterfaceNumberOfEntries" minEntries="0" maxEntries="unbounded">
<parameter name="X_CATAWAMPUS-ORG_ActualBitRate" access="readOnly" dmr:previousParameter="MaxBitRate">
<description>The current link speed of this interface (expressed in {{units}}).</description>
<syntax>
<unsignedInt>
<units value="Mbps"/>
</unsignedInt>
</syntax>
</parameter>
<parameter name="X_CATAWAMPUS-ORG_ActualDuplexMode" access="readOnly" dmr:previousParameter="DuplexMode">
<description>The current duplex mode of this connection.</description>
<syntax>
<string>
<enumeration value="Half"/>
<enumeration value="Full"/>
</string>
</syntax>
</parameter>
</object>
<object name="Device.Ethernet.Interface.{i}.Stats." access="readOnly" minEntries="1" maxEntries="1">
<parameter name="X_CATAWAMPUS-ORG_DiscardFrameCnts" access="readOnly">
<description>The count of discarded frames per queue.</description>
<syntax>
<list/>
<unsignedInt/>
</syntax>
</parameter>
<parameter name="X_CATAWAMPUS-ORG_DiscardPacketsReceivedHipri" access="readOnly">
<description>Number of discarded packets which were considered high priority.</description>
<syntax>
<unsignedInt/>
</syntax>
</parameter>
</object>
<object name="Device.DeviceInfo." access="readOnly" minEntries="1" maxEntries="1">
<parameter name="X_CATAWAMPUS-ORG_LedStatusNumberOfEntries" access="readOnly">
<description>The number of instances of {{object|.X_CATAWAMPUS-ORG_LedStatus.{i}.}}.</description>
<syntax>
<unsignedInt/>
</syntax>
</parameter>
</object>
<object name="Device.DeviceInfo.X_CATAWAMPUS-ORG_LedStatus.{i}." access="readOnly"
numEntriesParameter="X_CATAWAMPUS-ORG_LedStatusNumberOfEntries" minEntries="0" maxEntries="unbounded">
<description>This object reflects the state of an LED or other indicator light.</description>
<uniqueKey><parameter ref="Name"/></uniqueKey>
<parameter name="Name" access="readOnly">
<description>Name of this LED. This text MUST be sufficient to distinguish this object from others.</description>
<syntax><string><size maxLength="256"/></string></syntax>
</parameter>
<parameter name="Status" access="readOnly">
<description>
A description of the state of the indicator.
</description>
<syntax>
<string/>
</syntax>
</parameter>
</object>
<object name="Device.DeviceInfo.TemperatureStatus." access="readOnly" minEntries="1" maxEntries="1" />
<object name="Device.DeviceInfo.TemperatureStatus.X_CATAWAMPUS-ORG_Fan.{i}." access="readOnly"
numEntriesParameter="X_CATAWAMPUS-ORG_FanNumberOfEntries" minEntries="0" maxEntries="unbounded">
<description>This object represents information that the device has obtained via sampling a fan, blower, or other temperature management device.</description>
<uniqueKey><parameter ref="Name"/></uniqueKey>
<parameter name="Name" access="readOnly">
<description>Name of this fan. This text MUST be sufficient to distinguish this fan from others.</description>
<syntax><string><size maxLength="256"/></string></syntax>
</parameter>
<parameter name="RPM" access="readOnly">
<description>
Measured speed of the fan, in revolutions/minute.
</description>
<syntax>
<int/>
</syntax>
</parameter>
<parameter name="DesiredRPM" access="readOnly">
<description>
The calculated speed the system believes the fan should run at, given the current temperature. Measured in revolutions/minute.
</description>
<syntax>
<int/>
</syntax>
</parameter>
<parameter name="DesiredPercentage" access="readOnly">
<description>
Percentage for the level that the fan should run at.
</description>
<syntax>
<int/>
</syntax>
</parameter>
</object>
<object name="Device.DHCPv4.Server." access="readOnly" minEntries="1" maxEntries="1">
<parameter name="X_CATAWAMPUS-ORG_TextConfig" access="readWrite">
<description>For debugging purposes, the current contents of the DHCP server configuration file (for example, dnsmasq.conf).</description>
<syntax>
<string>
<size maxLength="65536"/>
</string>
</syntax>
</parameter>
</object>
<object name="Device.DHCPv4.Server.Pool.{i}." access="readWrite" numEntriesParameter="PoolNumberOfEntries" enableParameter="Enable" minEntries="0" maxEntries="unbounded">
<parameter name="X_CATAWAMPUS-ORG_NTPServers" access="readWrite">
<description>{{list}} List items represent NTP servers offered to DHCP clients.</description>
<syntax>
<list maxItems="4"/>
<dataType ref="string"/>
</syntax>
</parameter>
</object>
<object name="Device.DHCPv4.Server.Pool.{i}.StaticAddress.{i}." access="readWrite" numEntriesParameter="StaticAddressNumberOfEntries" enableParameter="Enable" minEntries="0" maxEntries="unbounded">
<uniqueKey>
<parameter ref="X_CATAWAMPUS-ORG_ClientID"/>
</uniqueKey>
<parameter name="X_CATAWAMPUS-ORG_ClientID" access="readWrite">
<description>Value of the DHCP Client Identifier (Option 61) as defined in {{bibref|RFC2132}} sent by the DHCP client.</description>
<syntax>
<hexBinary>
<size maxLength="255"/>
</hexBinary>
<default type="object" value=""/>
</syntax>
</parameter>
</object>
<object name="Device.Hosts.Host.{i}." access="readOnly" numEntriesParameter="HostNumberOfEntries" minEntries="0" maxEntries="unbounded">
<parameter name="IP4Address" access="readOnly">
<description>The first IPv4 address known for the Host, or an empty string if there are no addresses.</description>
<syntax>
<string>
<size maxLength="15"/>
</string>
</syntax>
</parameter>
<parameter name="IP6Address" access="readOnly">
<description>The first IPv6 address known for the Host, or an empty string if there are no addresses.</description>
<syntax>
<string>
<size maxLength="45"/>
</string>
</syntax>
</parameter>
</object>
<object name="Device.Hosts.Host.{i}.X_CATAWAMPUS_ORG_ClientIdentification." access="readOnly" minEntries="1" maxEntries="1">
<description>Information to identify a client device.</description>
<parameter name="Anonid" access="readOnly">
<description>An anonymized, 6 character identifier derived from the MAC address XORd with a random consensus_key shared by all Wifi APs within the BSSID. A MAC address which moves between APs in this account will have the same Anonid, but that same MAC address which roams to some other account's AP will have a different Anonid.</description>
<syntax>
<string>
<size maxLength="6"/>
</string>
</syntax>
</parameter>
<parameter name="DhcpTaxonomy" access="readOnly">
<description>A comma separated list of DHCP options requested by this client, in the order they were requested. Ex: 1,28,3,15,6,42</description>
<syntax>
<string>
<size maxLength="4096"/>
</string>
</syntax>
</parameter>
<parameter name="DnsSdName" access="readOnly">
<description>The hostname advertised using DNS-SD.</description>
<syntax>
<string>
<size maxLength="256"/>
</string>
</syntax>
</parameter>
<parameter name="NetbiosName" access="readOnly">
<description>The hostname advertised using NETBIOS.</description>
<syntax>
<string>
<size maxLength="16"/>
</string>
</syntax>
</parameter>
<parameter name="WifiDeviceModel" access="readOnly">
<description>The type of Wifi device if known, like 'Nexus 4'</description>
<syntax>
<string>
<size maxLength="128"/>
</string>
</syntax>
</parameter>
<parameter name="WifiTaxonomy" access="readOnly">
<description>The signature of a Wifi device, the string of options present in the client's Probe and Association frames.</description>
<syntax>
<string>
<size maxLength="4096"/>
</string>
</syntax>
</parameter>
</object>
<object name="Device.IP.Interface.{i}." access="readWrite" numEntriesParameter="InterfaceNumberOfEntries" enableParameter="Enable" minEntries="0" maxEntries="unbounded">
<parameter name="X_CATAWAMPUS-ORG_IP4Address" access="readOnly">
<description>First IPv4 address from IPv4Address.{i}, or an empty string if there are no addresses.</description>
<syntax>
<string>
<size maxLength="15"/>
</string>
</syntax>
</parameter>
<parameter name="X_CATAWAMPUS-ORG_IP6Address" access="readOnly">
<description>First IPv4 address from IPv6Address.{i}, or an empty string if there are no addresses.</description>
<syntax>
<string>
<size maxLength="45"/>
</string>
</syntax>
</parameter>
</object>
<object name="Device.MoCA.Interface.{i}." access="readOnly" numEntriesParameter="InterfaceNumberOfEntries" minEntries="0" maxEntries="unbounded" dmr:fixedObject="true">
<parameter name="X_CATAWAMPUS-ORG_ExtraTracing" access="readWrite">
<description>Enables or disables additional trace messages from mocad.</description>
<syntax>
<boolean/>
</syntax>
</parameter>
</object>
<object name="Device.MoCA.Interface.{i}.Stats." access="readOnly" minEntries="1" maxEntries="1">
<parameter name="X_CATAWAMPUS-ORG_DiscardFrameCnts" access="readOnly">
<description>The count of discarded frames per queue.</description>
<syntax>
<list/>
<unsignedInt/>
</syntax>
</parameter>
<parameter name="X_CATAWAMPUS-ORG_DiscardPacketsReceivedHipri" access="readOnly">
<description>Number of discarded packets which were considered high priority.</description>
<syntax>
<unsignedInt/>
</syntax>
</parameter>
</object>
<object name="Device.MoCA.Interface.{i}.AssociatedDevice.{i}." access="readOnly" numEntriesParameter="AssociatedDeviceNumberOfEntries" minEntries="0" maxEntries="unbounded">
<parameter name="X_CATAWAMPUS-ORG_RxPowerLevel_dBm" access="readOnly" dmr:previousParameter="RxPowerLevel">
<description>The RxPowerLevel in dBm.</description>
<syntax>
<float>
<units value="dBm"/>
</float>
</syntax>
</parameter>
<parameter name="X_CATAWAMPUS-ORG_RxBcastPowerLevel_dBm" access="readOnly" dmr:previousParameter="RxBcastPowerLevel">
<description>The RxBcastPowerLevel in dBm.</description>
<syntax>
<float>
<units value="dBm"/>
</float>
</syntax>
</parameter>
<parameter name="X_CATAWAMPUS-ORG_RxSNR_dB" access="readOnly" dmr:previousParameter="RxSNR">
<description>The Signal/Noise ratio in dB.</description>
<syntax>
<float>
<units value="dB"/>
</float>
</syntax>
</parameter>
<parameter name="X_CATAWAMPUS-ORG_RxNBAS" access="readOnly">
<description>The sum of the bitloading.</description>
<syntax>
<float/>
</syntax>
</parameter>
<parameter name="X_CATAWAMPUS-ORG_TxBitloading" access="readOnly" dmr:previousParameter="Active">
<description>A description of the signal quality of each subchannel, one character per subchannel.</description>
<syntax>
<string/>
</syntax>
</parameter>
<parameter name="X_CATAWAMPUS-ORG_RxBitloading" access="readOnly">
<description>A description of the signal quality of each subchannel, one character per subchannel.</description>
<syntax>
<string/>
</syntax>
</parameter>
<parameter name="X_CATAWAMPUS-ORG_RxPrimaryCwCorrected" access="readOnly">
<description>Number of code words received with errors and corrected.</description>
<syntax>
<string/>
</syntax>
</parameter>
<parameter name="X_CATAWAMPUS-ORG_RxPrimaryCwUncorrected" access="readOnly">
<description>Number of code words received with errors which could not be corrected.</description>
<syntax>
<string/>
</syntax>
</parameter>
<parameter name="X_CATAWAMPUS-ORG_RxPrimaryCwNoErrors" access="readOnly">
<description>Number of code words received without errors.</description>
<syntax>
<string/>
</syntax>
</parameter>
<parameter name="X_CATAWAMPUS-ORG_RxPrimaryCwNoSync" access="readOnly">
<description>Number of code words received where the PHY could not even sync.</description>
<syntax>
<string/>
</syntax>
</parameter>
<parameter name="X_CATAWAMPUS-ORG_RxSecondaryCwCorrected" access="readOnly">
<description>Number of code words received with errors and corrected.</description>
<syntax>
<string/>
</syntax>
</parameter>
<parameter name="X_CATAWAMPUS-ORG_RxSecondaryCwUncorrected" access="readOnly">
<description>Number of code words received with errors which could not be corrected.</description>
<syntax>
<string/>
</syntax>
</parameter>
<parameter name="X_CATAWAMPUS-ORG_RxSecondaryCwNoErrors" access="readOnly">
<description>Number of code words received without errors.</description>
<syntax>
<string/>
</syntax>
</parameter>
<parameter name="X_CATAWAMPUS-ORG_RxSecondaryCwNoSync" access="readOnly">
<description>Number of code words received where the PHY could not even sync.</description>
<syntax>
<string/>
</syntax>
</parameter>
</object>
<object name="Device.X_CATAWAMPUS-ORG.Experiments." access="readOnly" minEntries="1" maxEntries="1">
<parameter name="Available" access="readOnly">
<description>Comma-separated list of available experiments.</description>
<syntax>
<string>
<size maxLength="4096"/>
</string>
</syntax>
</parameter>
<parameter name="Requested" access="readWrite">
<description>Comma-separated list of desired experiments. It is not an error to request an experiment that is not in Available, although that will have no effect.</description>
<syntax>
<string>
<size maxLength="4096"/>
</string>
</syntax>
</parameter>
<parameter name="Active" access="readOnly">
<description>Comma-separated list of currently-active experiments. Generally is the intersection between Available and Requested.</description>
<syntax>
<string>
<size maxLength="4096"/>
</string>
</syntax>
</parameter>
</object>
<object name="Device.X_CATAWAMPUS-ORG.GFiberTV." access="readOnly" minEntries="1" maxEntries="1">
<description>Container for parameters supporting the Google Fiber TV system.</description>
<parameter name="DevicePropertiesNumberOfEntries" access="readOnly">
<description>Number of instances of {{object|DeviceProperties}}.</description>
<syntax>
<unsignedInt/>
</syntax>
</parameter>
<parameter name="EASHeartbeatTimestamp" access="readOnly">
<description>Timestamp of the last received Emergency Alert System heartbeat.</description>
<syntax>
<dateTime/>
</syntax>
</parameter>
<parameter name="EASFipsCode" access="readWrite">
<description>FIPS Code for the Emergency Alert System.</description>
<syntax>
<string/>
</syntax>
</parameter>
<parameter name="EASServiceAddress" access="readWrite">
<description>Multicast address to monitor for the the Emergency Alert System.</description>
<syntax>
<string/>
</syntax>
</parameter>
<parameter name="EASServicePort" access="readWrite">
<description>UDP Port number to monitor for the the Emergency Alert System.</description>
<syntax>
<unsignedInt/>
</syntax>
</parameter>
<parameter name="TcpAlgorithm" access="readWrite">
<description>TCP congestion control algorithm to use on the sockets sending data to TV boxes. This setting takes effect in a few minutes.</description>
<syntax>
<string/>
</syntax>
</parameter>
<parameter name="UiChoice" access="readOnly">
<description>UI version which will be run. If UiType is not set, this will be a platform default.</description>
<syntax>
<string/>
</syntax>
</parameter>
<parameter name="UiControlUrl" access="readWrite">
<description>URL for UI Control.</description>
<syntax>
<string/>
</syntax>
</parameter>
<parameter name="UiType" access="readWrite">
<description>UI version to run.</description>
<syntax>
<string/>
</syntax>
</parameter>
<parameter name="TvBufferAddress" access="readWrite">
<description>The ip:port address of the buffering service. Enables use of the service if present and non-empty.</description>
<syntax>
<string/>
</syntax>
</parameter>
<parameter name="TvBufferKey" access="readWrite">
<description>Key used to allow access to the buffering service.</description>
<syntax>
<string/>
</syntax>
</parameter>
<parameter name="FrobnicastAddress" access="readWrite">
<description>The ip:port address of the Frobnicast service. Enables use of the service if present and non-empty</description>
<syntax>
<string/>
</syntax>
</parameter>
<parameter name="FrobnicastKey" access="readWrite">
<description>Key used to allow access to the Frobnicast service</description>
<syntax>
<string/>
</syntax>
</parameter>
<object name="DvrSpace." access="readOnly" minEntries="1" maxEntries="1">
<parameter name="PermanentFiles" access="readOnly">
<description>Number of permanent DVR files currently stored.</description>
<syntax>
<unsignedInt/>
</syntax>
</parameter>
<parameter name="PermanentMBytes" access="readOnly">
<description>Number of Megabytes of permanent DVR files currently stored.</description>
<syntax>
<unsignedInt/>
</syntax>
</parameter>
<parameter name="TransientFiles" access="readOnly">
<description>Number of transient DVR files currently stored. Transient files can be deleted as needed by the DVR, as part of its normal operation.</description>
<syntax>
<unsignedInt/>
</syntax>
</parameter>
<parameter name="TransientMBytes" access="readOnly">
<description>Number of Megabytes of transient DVR files currently stored. Transient files can be deleted as needed by the DVR, as part of its normal operation.</description>
<syntax>
<unsignedInt/>
</syntax>
</parameter>
</object>
<object name="DeviceProperties.{i}." access="readWrite" numEntriesParameter="DevicePropertiesNumberOfEntries" minEntries="0" maxEntries="16">
<parameter name="SerialNumber" access="readWrite">
<description>Serial number of the device.</description>
<syntax>
<string/>
</syntax>
</parameter>
<parameter name="NickName" access="readWrite">
<description>Nickname of the device.</description>
<syntax>
<string/>
</syntax>
</parameter>
</object>
</object>
<object name="Device.X_CATAWAMPUS-ORG.GVSB." access="readOnly" minEntries="1" maxEntries="1">
<description>GVSB Configuration.</description>
<parameter name="GvsbServer" access="readWrite">
<description>URL of the GVSB server.</description>
<syntax>
<string>
<size maxLength="2000"/>
</string>
</syntax>
</parameter>
<parameter name="GvsbChannelLineup" access="readWrite">
<description>Identifier for the current channel lineup.</description>
<syntax>
<base64>
<size minLength="1" maxLength="64"/>
</base64>
</syntax>
</parameter>
<parameter name="GvsbKick" access="readWrite">
<description>Current Kick value. Whenever the Kick value changes, device will re-fetch the channel list.</description>
<syntax>
<string>
<size maxLength="64"/>
</string>
</syntax>
</parameter>
<parameter name="EpgPrimary" access="readWrite">
<description>Multicast IP address and port of the primary EPG feed. For example, "224.254.1.1:5000"</description>
<syntax>
<string>
<size maxLength="128"/>
</string>
</syntax>
</parameter>
<parameter name="EpgSecondary" access="readWrite">
<description>Multicast IP address and port of the secondary EPG feed. For example, "224.254.1.2:5000"</description>
<syntax>
<string>
<size maxLength="128"/>
</string>
</syntax>
</parameter>
<parameter name="EpgUrl" access="readWrite">
<description>URL of the EPG feed, eg: https://tv.prod.gfsvc.com/static/epginfo/prod</description>
<syntax>
<string>
<size maxLength="1024"/>
</string>
</syntax>
</parameter>
</object>
<object name="Device.X_CATAWAMPUS-ORG.HAT." access="readOnly" minEntries="1" maxEntries="1">
<description>Container for parameters supporting the HAT system.</description>
<parameter name="HAT" access="readWrite">
<description>If set to true, this variable turns off anything related to the HAT system.</description>
<syntax>
<boolean/>
</syntax>
</parameter>
<parameter name="Insert" access="readWrite">
<description>Turns on/off the HAT insertion.</description>
<syntax>
<boolean/>
</syntax>
</parameter>
<parameter name="TestCueTones" access="readWrite">
<description>Turns on/off HAT cue tones parsing.</description>
<syntax>
<boolean/>
</syntax>
</parameter>
<parameter name="DVRReplacement" access="readWrite">
<description>Turns on/off HAT DVR replacement.</description>
<syntax>
<unsignedInt/>
</syntax>
</parameter>
<parameter name="HatRequestMaxDelaySecs" access="readWrite">
<description>Max time to wait before making a hat request.</description>
<syntax>
<unsignedLong/>
</syntax>
</parameter>
<parameter name="MinChannelDwellTimeSecs" access="readWrite">
<description>Min time a channel was viewed before making a hat request.</description>
<syntax>
<unsignedLong/>
</syntax>
</parameter>
<parameter name="MinRepeatHatReportIntervalSecs" access="readWrite">
<description>Max time after which a repeat hat view can be reported.</description>
<syntax>
<unsignedLong/>
</syntax>
</parameter>
<parameter name="MinActiveViewingHeuristicSecs" access="readWrite">
<description>Min time till which a viewing can be considered active.</description>
<syntax>
<unsignedLong/>
</syntax>
</parameter>
<parameter name="DiskSpaceLimitGb" access="readWrite">
<description>Max disk space we can use for hat - in gigabytes.</description>
<syntax>
<unsignedLong/>
</syntax>
</parameter>
<parameter name="DiskSpaceLowWatermarkPercent" access="readWrite">
<description>Percent value of disk space limit we should strive to keep disk usage at.</description>
<syntax>
<unsignedLong/>
</syntax>
</parameter>
<parameter name="DiskSpaceHighWatermarkPercent" access="readWrite">
<description>Percent value of disk space limit we should keep disk usage under.</description>
<syntax>
<unsignedLong/>
</syntax>
</parameter>
<parameter name="DiskSpaceCleanupIntervalSecs" access="readWrite">
<description>Interval (in secs) to cleanup disk space.</description>
<syntax>
<unsignedLong/>
</syntax>
</parameter>
<parameter name="HatCatalogPollingIntervalSecs" access="readWrite">
<description>Polling interval (in secs) to check for an updated hat catalog.</description>
<syntax>
<unsignedLong/>
</syntax>
</parameter>
<parameter name="AdFetchMaxLeadTimeSecs" access="readWrite">
<description>At most how long before an ad is needed to fetch its creative file.</description>
<syntax>
<unsignedLong/>
</syntax>
</parameter>
<parameter name="AdCreativeGracePeriodSecs" access="readWrite">
<description>How long a creative should stay in the disk after it has disappear from the catalog.</description>
<syntax>
<unsignedLong/>
</syntax>
</parameter>
<parameter name="MinImpressionViewDurationPts" access="readWrite">
<description>Duration (in pts) of an ad viewing that turns it into an impression.</description>
<syntax>
<long/>
</syntax>
</parameter>
<parameter name="GFASUrl" access="readWrite">
<description>URL of the GFAS server.</description>
<syntax>
<string/>
</syntax>
</parameter>
<parameter name="HATContracts" access="readWrite">
<description>The HAT contracts file.</description>
<syntax>
<string/>
</syntax>
</parameter>
<parameter name="CueToneFiredAdRequests" access="readWrite">
<description>Turns on/off cuetone-triggered ad requests.</description>
<syntax>
<boolean/>
</syntax>
</parameter>
<parameter name="FrameAccurateSplicing" access="readWrite">
<description>Turns on/off frame-accurate splicing (go/fasp).</description>
<syntax>
<boolean/>
</syntax>
</parameter>
<parameter name="FetcherThrottlingIntervals" access="readWrite">
<description>List of intervals for the fetcher to know the bandwidth limit and how many downloads can be performed in that timeframe.</description>
<syntax>
<string/>
</syntax>
</parameter>
<parameter name="AdscaleMulticastAddress" access="readWrite">
<description>Multicast Address used to receive data from the adscale backend (see go/adscale for more information).</description>
<syntax>
<string/>
</syntax>
</parameter>
<parameter name="InteractiveAds" access="readWrite">
<description>Turns on/off interactive ads (go/interactive-ads).</description>
<syntax>
<boolean/>
</syntax>
</parameter>
<parameter name="MarketId" access="readWrite">
<description>TMA (market id) for the customer.</description>
<syntax>
<string/>
</syntax>
</parameter>
</object>
<object name="Device.X_CATAWAMPUS-ORG.SelfTest." access="readOnly" minEntries="1" maxEntries="1">
<description>Parameters for configuring an automated self test.</description>
<parameter name="ServerIP" access="readWrite">
<description>For clients (ie. TV box) the server (storage box) to
connect to. If this parameter is omitted, scans the local network
for a server.</description>
<syntax>
<dataType ref="IPAddress"/>
</syntax>
</parameter>
<parameter name="AutoRestartEnable" access="readWrite">
<description>If true, restart the test after it passes or fails.</description>
<syntax>
<boolean/>
</syntax>
</parameter>
<parameter name="MaxBitRate" access="readWrite">
<description>Maximum data transmit rate, in {{units}}. 0 means no
transmission, and values less than zero mean unlimited.</description>
<syntax>
<float>
<units value="Mbps"/>
</float>
</syntax>
</parameter>
<parameter name="Mode" access="readWrite">
<description>The current self-test mode. Set to None to disable
the test, StressTest to enable the stress test, or Throughput to
run a LAN bandwidth test. Other kinds of tests may be added in
the future.</description>
<syntax>
<string>
<enumeration value="None"/>
<enumeration value="Success"/>
<enumeration value="Error"/>
<enumeration value="StressTest"/>
<enumeration value="Throughput"/>
</string>
</syntax>
</parameter>
<parameter name="LastResult" access="readOnly">
<description>The result of the most recent test run. 0 means
success.</description>
<syntax>
<unsignedInt/>
</syntax>
</parameter>
<parameter name="LastResultTime" access="readOnly">
<description>The time of the most recent test run.</description>
<syntax>
<dateTime/>
</syntax>
</parameter>
<parameter name="Log" access="readOnly">
<description>The most recent output of the test script.</description>
<syntax>
<string>
<size maxLength="100000"/>
</string>
</syntax>
</parameter>
</object>
<object name="Device.X_CATAWAMPUS-ORG.Speedtest." access="readOnly" minEntries="1" maxEntries="1">
<description>This object provides access to an IP-layer performance test.</description>
<parameter name="DiagnosticsState" access="readWrite" activeNotify="canDeny">
<description>Indicates availability of diagnostic data. {{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 value is {{enum|Requested}}. To ensure the use of the proper test parameters (the writable parameters in this object), the test parameters MUST be set either prior to or at the same time as (in the same SetParameterValues) setting the {{param}} to {{enum|Requested}}.
When requested, the CPE SHOULD wait until after completion of the communication session with the ACS before starting the diagnostic.
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), 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.</description>
<syntax>
<string>
<enumeration value="None" access="readOnly"/>
<enumeration value="Requested"/>
<enumeration value="Complete" access="readOnly"/>
<enumeration value="Error_Internal" access="readOnly"/>
<enumeration value="Error_Other" access="readOnly"/>
</string>
</syntax>
</parameter>
<parameter name="License" access="readWrite">
<description>The license and test configuration to be used for the speed test invocation.</description>
<syntax>
<string>
<size maxLength="16384"/>
</string>
</syntax>
</parameter>
<parameter name="Arguments" access="readWrite">
<description>Arguments to pass to the speedtest. This string will be broken into distinct arguments at whitespaces. Note that no shell is involved, and shell substitutions will not be performed.</description>
<syntax>
<string>
<size maxLength="1024"/>
</string>
</syntax>
</parameter>
<parameter name="Output" access="readOnly">
<description>The output of the speed test run.</description>
<syntax>
<string>
<size maxLength="65536"/>
</string>
</syntax>
</parameter>
<parameter name="LastResultTime" access="readOnly">
<description>The time of the most recent speedtest run.</description>
<syntax>
<dateTime/>
</syntax>
</parameter>
</object>
<object name="Device.X_CATAWAMPUS-ORG.Isostream." access="readOnly" minEntries="1" maxEntries="1">
<description>This object provides access to run an IP-layer jitter/throughput test.The results are very detailed and available only via the system logs.</description>
<parameter name="ServerEnable" access="readWrite">
<description>True if this device should accept incoming connections.</description>
<syntax>
<boolean/>
</syntax>
</parameter>
<parameter name="ServerConcurrentConnections" access="readWrite">
<description>Limit the isostream server to this many parallel connections. If zero, the only limit is the one compiled into isostream.</description>
<syntax>
<unsignedInt/>
</syntax>
</parameter>
<parameter name="ServerTimeLimit" access="readWrite">
<description>Automatically disable the server if it runs for more than this many seconds. If zero, there is no limit.</description>
<syntax>
<unsignedInt/>
</syntax>
</parameter>
<parameter name="ServerCongestionControl" access="readWrite">
<description>TCP congestion control to use for transmitting.</description>
<syntax>
<string>
<size maxLength="128"/>
</string>
</syntax>
</parameter>
<parameter name="ClientRunning" access="readOnly">
<description>True if this device is running an isostream client right now.</description>
<syntax>
<boolean/>
</syntax>
</parameter>
<parameter name="ClientEnable" access="readWrite">
<description>True if the ACS wants us running a client right now.</description>
<syntax>
<boolean/>
</syntax>
</parameter>
<parameter name="ClientEnableByScheduler" access="readOnly">
<description>True if the scheduler wants this device running an isostream client right now.</description>
<syntax>
<boolean/>
</syntax>
</parameter>
<parameter name="ClientRunOnSchedule" access="readWrite">
<description>True if this device should schedule a daily test run in the half-open interval [ClientStartAtOrAfter, ClientEndBefore).</description>
<syntax>
<boolean/>
</syntax>
</parameter>
<parameter name="ClientStartAtOrAfter" access="readWrite">
<description>Earliest time of day, in seconds after midnight local time, when clients will try to connect to isostream.</description>
<syntax>
<unsignedInt/>
</syntax>
</parameter>
<parameter name="ClientEndBefore" access="readWrite">
<description>Latest time of day, in seconds after midnight local time, when clients will try to connect to isostream.</description>
<syntax>
<unsignedInt/>
</syntax>
</parameter>
<parameter name="ClientDeadline" access="readOnly">
<description>If a daily test run is scheduled, the deadline to start the scheduled run.</description>
<syntax>
<dateTime/>
</syntax>
</parameter>
<parameter name="ClientDisableIfPortActive" access="readWrite">
<description>If nonzero, disable isostream client if a TCP connection exists on the given port.</description>
<syntax>
<unsignedInt/>
</syntax>
</parameter>
<parameter name="ClientTimeSufficient" access="readWrite">
<description>Instruct isostream to exit if it successfully conducts a test for at least this many seconds.</description>
<syntax>
<unsignedInt/>
</syntax>
</parameter>
<parameter name="ClientTimeLimit" access="readWrite">
<description>Automatically disable the client if it runs for more than this many seconds.</description>
<syntax>
<unsignedInt/>
</syntax>
</parameter>
<parameter name="ClientRemoteIP" access="readWrite">
<description>IP address or hostname of server to connect to. If this is set to the empty string, the client will attemp to connect to the nearest GFiberTV storage box if there is one on the LAN.</description>
<syntax>
<string>
<size maxLength="128"/>
</string>
</syntax>
</parameter>
<parameter name="ClientInterface" access="readWrite">
<description>If specified, bind isostream client socket to this network interface on the client device. Required for correct operation if ClientRemoteIP is set to a link-local IPv6 address, or if ClientRemoteIP is set to the empty string and a link-local IPv6 address might be detected.</description>
<syntax>
<string>
<size maxLength="15"/>
</string>
</syntax>
</parameter>
<parameter name="ClientMbps" access="readWrite">
<description>The data rate to use for the client connection in Mbits/sec.</description>
<syntax>
<unsignedInt/>
</syntax>
</parameter>
</object>
<object name="Device.X_CATAWAMPUS-ORG.HttpDownload." access="readOnly" minEntries="1" maxEntries="1">
<description>Download a URL using http or https. The file is sent to /dev/null, not stored on the device.</description>
<parameter name="DiagnosticsState" access="readWrite" activeNotify="canDeny">
<description>Indicates availability of diagnostic data. {{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 value is {{enum|Requested}}. To ensure the use of the proper test parameters (the writable parameters in this object), the test parameters MUST be set either prior to or at the same time as (in the same SetParameterValues) setting the {{param}} to {{enum|Requested}}.
When requested, the CPE SHOULD wait until after completion of the communication session with the ACS before starting the diagnostic.
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.
</description>
<syntax>
<string>
<enumeration value="None" access="readOnly"/>
<enumeration value="Requested"/>
<enumeration value="Complete" access="readOnly"/>
<enumeration value="Error_Internal" access="readOnly"/>
<enumeration value="Error_Other" access="readOnly"/>
</string>
</syntax>
</parameter>
<parameter name="IPVersion" access="readWrite">
<description>The connection can be restricted to IPv4 or IPv6.</description>
<syntax>
<string>
<enumeration value="Unspecified"/>
<enumeration value="IPv4"/>
<enumeration value="IPv6"/>
</string>
<default type="object" value="Unspecified"/>
</syntax>
</parameter>
<parameter name="LimitMbps" access="readWrite">
<description>If non-zero, limit the download to this many Mbits/sec.</description>
<syntax><unsignedInt/></syntax>
</parameter>
<parameter name="Result" access="readOnly">
<description>Text output generated during the HTTP test.</description>
<syntax><string/></syntax>
</parameter>
<parameter name="Timeout" access="readWrite">
<description>Automatically terminate after this many seconds.</description>
<syntax><unsignedInt/></syntax>
</parameter>
<parameter name="URL" access="readWrite">
<description>The URL to access.</description>
<syntax><boolean/></syntax>
</parameter>
</object>
<object name="Device.X_CATAWAMPUS-ORG.Ping." access="readOnly" minEntries="1" maxEntries="1">
<description>Ping a host on the Internet and send the result.</description>
<parameter name="DiagnosticsState" access="readWrite" activeNotify="canDeny">
<description>Indicates availability of diagnostic data. {{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 value is {{enum|Requested}}. To ensure the use of the proper test parameters (the writable parameters in this object), the test parameters MUST be set either prior to or at the same time as (in the same SetParameterValues) setting the {{param}} to {{enum|Requested}}.
When requested, the CPE SHOULD wait until after completion of the communication session with the ACS before starting the diagnostic.
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.
</description>
<syntax>
<string>
<enumeration value="None" access="readOnly"/>
<enumeration value="Requested"/>
<enumeration value="Complete" access="readOnly"/>
<enumeration value="Error_CannotResolveHostName" access="readOnly"/>
<enumeration value="Error_NoRouteToHost" access="readOnly"/>
<enumeration value="Error_Internal" access="readOnly"/>
<enumeration value="Error_Other" access="readOnly"/>
</string>
</syntax>
</parameter>
<parameter name="DSCP" access="readWrite">
<description>DiffServ codepoint to be used for the test packets. By default the CPE SHOULD set this value to zero.</description>
<syntax>
<unsignedInt>
<range minInclusive="0" maxInclusive="63"/>
</unsignedInt>
</syntax>
</parameter>
<parameter name="Host" access="readWrite">
<description>The host to ping. This can be an IPv4 address, an IPv6 address, or a hostname..</description>
<syntax>
<string>
<size maxLength="256"/>
</string>
</syntax>
</parameter>
<parameter name="NumberOfRepetitions" access="readWrite">
<description>Number of repetitions of the ping test to perform before reporting the results.</description>
<syntax>
<unsignedInt>
<range minInclusive="1"/>
</unsignedInt>
</syntax>
</parameter>
<parameter name="ProtocolVersion" access="readWrite">
<description>The connection can be restricted to IPv4 or IPv6.</description>
<syntax>
<string>
<enumeration value="Unspecified"/>
<enumeration value="IPv4"/>
<enumeration value="IPv6"/>
</string>
<default type="object" value="Unspecified"/>
</syntax>
</parameter>
<parameter name="Result" access="readOnly">
<description>Text output generated during the ping test.</description>
<syntax><string/></syntax>
</parameter>
<parameter name="Timeout" access="readWrite">
<description>Timeout in {{units}} for the ping test.</description>
<syntax>
<unsignedInt>
<range minInclusive="1"/>
<units value="seconds"/>
</unsignedInt>
</syntax>
</parameter>
</object>
<object name="Device.X_CATAWAMPUS-ORG.Iperf3." access="readOnly" minEntries="1" maxEntries="1">
<description>Run iperf3 and send the result.</description>
<parameter name="DiagnosticsState" access="readWrite" activeNotify="canDeny">
<description>Indicates availability of diagnostic data. {{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 value is {{enum|Requested}}. To ensure the use of the proper test parameters (the writable parameters in this object), the test parameters MUST be set either prior to or at the same time as (in the same SetParameterValues) setting the {{param}} to {{enum|Requested}}.
When requested, the CPE SHOULD wait until after completion of the communication session with the ACS before starting the diagnostic.
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.
</description>
<syntax>
<string>
<enumeration value="None" access="readOnly"/>
<enumeration value="Requested"/>
<enumeration value="Complete" access="readOnly"/>
<enumeration value="Error_Internal" access="readOnly"/>
<enumeration value="Error_Other" access="readOnly"/>
</string>
</syntax>
</parameter>
<parameter name="DSCP" access="readWrite">
<description>DiffServ codepoint to be used for the test packets. By default the CPE SHOULD set this value to zero.</description>
<syntax>
<unsignedInt>
<range minInclusive="0" maxInclusive="63"/>
</unsignedInt>
</syntax>
</parameter>
<parameter name="ExtraArguments" access="readWrite">
<description>Space-separated extra arguments to be passed to iperf3.</description>
<syntax>
<string>
<size maxLength="256"/>
</string>
</syntax>
</parameter>
<parameter name="Host" access="readWrite">
<description>If set, run iperf in client mode and directed to this host. This can be an IPv4 address, an IPv6 address, or a hostname. If not set, run iperf3 in server mode.</description>
<syntax>
<string>
<size maxLength="256"/>
</string>
</syntax>
</parameter>
<parameter name="ProtocolVersion" access="readWrite">
<description>The connection can be restricted to IPv4 or IPv6.</description>
<syntax>
<string>
<enumeration value="Unspecified"/>
<enumeration value="IPv4"/>
<enumeration value="IPv6"/>
</string>
<default type="object" value="Unspecified"/>
</syntax>
</parameter>
<parameter name="Result" access="readOnly">
<description>Text output generated during the iperf3 test.</description>
<syntax><string/></syntax>
</parameter>
</object>
<object name="Device.X_CATAWAMPUS-ORG.Iperf.{i}." access="readWrite" numEntriesParameter="IperfNumberOfEntries" minEntries="1" maxEntries="unbounded">
<description>Run iperf3 and send the result.</description>
<parameter name="DiagnosticsState" access="readWrite" activeNotify="canDeny">
<description>Indicates availability of diagnostic data. {{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 value is {{enum|Requested}}. To ensure the use of the proper test parameters (the writable parameters in this object), the test parameters MUST be set either prior to or at the same time as (in the same SetParameterValues) setting the {{param}} to {{enum|Requested}}.
When requested, the CPE SHOULD wait until after completion of the communication session with the ACS before starting the diagnostic.
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.
</description>
<syntax>
<string>
<enumeration value="None" access="readOnly"/>
<enumeration value="Requested"/>
<enumeration value="Complete" access="readOnly"/>
<enumeration value="Error_Internal" access="readOnly"/>
<enumeration value="Error_Other" access="readOnly"/>
</string>
</syntax>
</parameter>
<parameter name="DSCP" access="readWrite">
<description>DiffServ codepoint to be used for the test packets. By default the CPE SHOULD set this value to zero.</description>
<syntax>
<unsignedInt>
<range minInclusive="0" maxInclusive="63"/>
</unsignedInt>
</syntax>
</parameter>
<parameter name="ExtraArguments" access="readWrite">
<description>Space-separated extra arguments to be passed to iperf3.</description>
<syntax>
<string>
<size maxLength="256"/>
</string>
</syntax>
</parameter>
<parameter name="Host" access="readWrite">
<description>If set, run iperf in client mode and directed to this host. This can be an IPv4 address, an IPv6 address, or a hostname. If not set, run iperf3 in server mode.</description>
<syntax>
<string>
<size maxLength="256"/>
</string>
</syntax>
</parameter>
<parameter name="ProtocolVersion" access="readWrite">
<description>The connection can be restricted to IPv4 or IPv6.</description>
<syntax>
<string>
<enumeration value="Unspecified"/>
<enumeration value="IPv4"/>
<enumeration value="IPv6"/>
</string>
<default type="object" value="Unspecified"/>
</syntax>
</parameter>
<parameter name="Result" access="readOnly">
<description>Text output generated during the iperf3 test.</description>
<syntax><string/></syntax>
</parameter>
</object>
<object base="Device.IP.Diagnostics.TraceRoute." access="readOnly" minEntries="1" maxEntries="1">
<parameter name="IPVersion" access="readWrite">
<description>The connection can be restricted to IPv4 or IPv6.</description>
<syntax>
<string>
<enumeration value="Unspecified"/>
<enumeration value="IPv4"/>
<enumeration value="IPv6"/>
</string>
<default type="object" value="Unspecified"/>
</syntax>
</parameter>
</object>
<object name="Device.IP.Diagnostics." access="readOnly" minEntries="1" maxEntries="1">
<parameter name="X_CATAWAMPUS-ORG_ExtraPing4Servers" access="readWrite" activeNotify="canDeny">
<description>A comma-delimited list of more sites to ping using IPv4 at regular intervals.</description>
<syntax><string><size maxLength="8192"/></string></syntax>
</parameter>
<parameter name="X_CATAWAMPUS-ORG_ExtraPing6Servers" access="readWrite" activeNotify="canDeny">
<description>A comma-delimited list of more sites to ping using IPv6 at regular intervals.</description>
<syntax><string><size maxLength="8192"/></string></syntax>
</parameter>
</object>
<object name="Device.NAT.PortMapping.{i}." access="readWrite" numEntriesParameter="PortMappingNumberOfEntries" enableParameter="Enable" minEntries="0" maxEntries="unbounded">
<parameter name="X_CATAWAMPUS-ORG_PortRangeSize" access="readWrite">
<description>Maps a contiguous set of ports starting with {{param|ExternalPort}} mapped to {{param|InternalPort}},
{{param|ExternalPort}} + 1 mapped to {{param|InternalPort}} +1, etc for {{param|X_CATAWAMPUS-ORG_PortRangeSize}} ports.
A value of zero (0) indicates that no set of ports is specified, i.e. that the mapping is only {{param|ExternalPort}} to {{param|InternalPort}}.
If {{param|ExternalPort}} is zero (wildcard), the value of this parameter MUST be ignored.
If both {{param|X_CATAWAMPUS-ORG_PortRangeSize}} and {{param|ExternalPortEndRange}} are set, the results are undefined.</description>
<syntax>
<unsignedInt>
<range minInclusive="0" maxInclusive="65535"/>
</unsignedInt>
<default type="object" value="0"/>
</syntax>
</parameter>
</object>
<object name="Device.NAT.X_CATAWAMPUS-ORG_DmzMapping.{i}." access="readWrite" numEntriesParameter="DmzMappingNumberOfEntries" enableParameter="Enable" minEntries="0" maxEntries="unbounded">
<parameter name="WanAddress" access="readWrite">
<description>External IPv4 Address.</description>
<syntax>
<string>
<size maxLength="32"/>
</string>
</syntax>
</parameter>
<parameter name="LanAddress" access="readWrite">
<description>Internal IPv4 address.</description>
<syntax>
<string>
<size maxLength="32"/>
</string>
</syntax>
</parameter>
</object>
<object name="Device.X_CATAWAMPUS-ORG.Wifiblaster." access="readOnly" minEntries="1" maxEntries="1">
<description>This object provides access to a WiFi performance tester.</description>
<parameter name="Duration" access="readWrite">
<description>Measurement duration in seconds.</description>
<syntax><float/></syntax>
</parameter>
<parameter name="Enable" access="readWrite">
<description>Enable WiFi performance measurement.</description>
<syntax><boolean/></syntax>
</parameter>
<parameter name="Fraction" access="readWrite">
<description>Number of samples per measurement.</description>
<syntax><unsignedInt/></syntax>
</parameter>
<parameter name="Interval" access="readWrite">
<description>Average time between automated measurements in seconds, or 0 to disable automated measurements.</description>
<syntax><float/></syntax>
</parameter>
<parameter name="MeasureAll" access="readWrite">
<description>Unix time at which to measure all clients.</description>
<syntax><unsignedInt/></syntax>
</parameter>
<parameter name="OnAssociation" access="readWrite">
<description>Enable WiFi performance measurement after clients associate.</description>
<syntax><boolean/></syntax>
</parameter>
<parameter name="Size" access="readWrite">
<description>Packet size in bytes.</description>
<syntax><unsignedInt/></syntax>
</parameter>
</object>
<object name="Device.X_CATAWAMPUS-ORG.Glaukus." access="readOnly" minEntries="1" maxEntries="1"/>
<object name="Device.X_CATAWAMPUS-ORG.Glaukus.Modem." access="readOnly" minEntries="1" maxEntries="1">
<description>Container for Glaukus Manager Modem statistics.</description>
<parameter name="StatusCode" access="readOnly">
<syntax><int/></syntax>
</parameter>
<parameter name="StatusStr" access="readOnly">
<syntax><string/></syntax>
</parameter>
<parameter name="ModemFirmware" access="readOnly">
<syntax><string/></syntax>
</parameter>
<parameter name="ModemProfile" access="readOnly">
<syntax><string/></syntax>
</parameter>
</object>
<object name="Device.X_CATAWAMPUS-ORG.Glaukus.Modem.RxCounters." access="readOnly" minEntries="1" maxEntries="1">
<description>Modem RX counters.</description>
<parameter name="Broadcast" access="readOnly">
<syntax><int/></syntax>
</parameter>
<parameter name="Bytes" access="readOnly">
<syntax><int/></syntax>
</parameter>
<parameter name="CrcErrors" access="readOnly">
<syntax><int/></syntax>
</parameter>
<parameter name="Frames" access="readOnly">
<syntax><int/></syntax>
</parameter>
<parameter name="Frames1024_1518" access="readOnly">
<syntax><int/></syntax>
</parameter>
<parameter name="Frames128_255" access="readOnly">
<syntax><int/></syntax>
</parameter>
<parameter name="Frames256_511" access="readOnly">
<syntax><int/></syntax>
</parameter>
<parameter name="Frames512_1023" access="readOnly">
<syntax><int/></syntax>
</parameter>
<parameter name="Frames64" access="readOnly">
<syntax><int/></syntax>
</parameter>
<parameter name="Frames65_127" access="readOnly">
<syntax><int/></syntax>
</parameter>
<parameter name="FramesJumbo" access="readOnly">
<syntax><int/></syntax>
</parameter>
<parameter name="FramesUndersized" access="readOnly">
<syntax><int/></syntax>
</parameter>
<parameter name="Multicast" access="readOnly">
<syntax><int/></syntax>
</parameter>
<parameter name="Unicast" access="readOnly">
<syntax><int/></syntax>
</parameter>
</object>
<object name="Device.X_CATAWAMPUS-ORG.Glaukus.Modem.TxCounters." access="readOnly" minEntries="1" maxEntries="1">
<description>Modem TX counters.</description>
<parameter name="Broadcast" access="readOnly">
<syntax><int/></syntax>
</parameter>
<parameter name="Bytes" access="readOnly">
<syntax><int/></syntax>
</parameter>
<parameter name="CrcErrors" access="readOnly">
<syntax><int/></syntax>
</parameter>
<parameter name="Frames" access="readOnly">
<syntax><int/></syntax>
</parameter>
<parameter name="Frames1024_1518" access="readOnly">
<syntax><int/></syntax>
</parameter>
<parameter name="Frames128_255" access="readOnly">
<syntax><int/></syntax>
</parameter>
<parameter name="Frames256_511" access="readOnly">
<syntax><int/></syntax>
</parameter>
<parameter name="Frames512_1023" access="readOnly">
<syntax><int/></syntax>
</parameter>
<parameter name="Frames64" access="readOnly">
<syntax><int/></syntax>
</parameter>
<parameter name="Frames65_127" access="readOnly">
<syntax><int/></syntax>
</parameter>
<parameter name="FramesJumbo" access="readOnly">
<syntax><int/></syntax>
</parameter>
<parameter name="FramesUndersized" access="readOnly">
<syntax><int/></syntax>
</parameter>
<parameter name="Multicast" access="readOnly">
<syntax><int/></syntax>
</parameter>
<parameter name="Unicast" access="readOnly">
<syntax><int/></syntax>
</parameter>
</object>
<object name="Device.X_CATAWAMPUS-ORG.Glaukus.Modem.Status." access="readOnly" minEntries="1" maxEntries="1">
<description>Status of the modem.</description>
<parameter name="AbsoluteMse" access="readOnly">
<description>Absolute MSE in dB.</description>
<syntax><int><units value="dB"/></int></syntax>
</parameter>
<parameter name="AcmEngineRxSensorsEnabled" access="readOnly">
<description>ACM Engine RX Sensors Enabled.</description>
<syntax><boolean/></syntax>
</parameter>
<parameter name="AcmEngineTxSwitchEnabled" access="readOnly">
<description>ACM Engine TX Switch Enabled.</description>
<syntax><boolean/></syntax>
</parameter>
<parameter name="AcquireStatus" access="readOnly">
<description>Acquire status code.</description>
<syntax><int/></syntax>
</parameter>
<parameter name="AcquireStatusStr" access="readOnly">
<description>Acquire status string.</description>
<syntax><string/></syntax>
</parameter>
<parameter name="CarrierOffset" access="readOnly">
<description>Carrier offset.</description>
<syntax><int/></syntax>
</parameter>
<parameter name="DebugIndications" access="readOnly">
<description>Debug indications.</description>
<syntax><int/></syntax>
</parameter>
<parameter name="LastAcquireError" access="readOnly">
<description>Last acquire error.</description>
<syntax><int/></syntax>
</parameter>
<parameter name="LastAcquireErrorStr" access="readOnly">
<description>Last acquire error string.</description>
<syntax><string/></syntax>
</parameter>
<parameter name="NormalizedMse" access="readOnly">
<description>Normalized MSE in dB.</description>
<syntax><int><units value="dB"/></int></syntax>
</parameter>
<parameter name="RadialMse" access="readOnly">
<description>Radial MSE in dB.</description>
<syntax><int><units value="dB"/></int></syntax>
</parameter>
<parameter name="ResPhNoiseVal" access="readOnly">
<description>Res Ph Noise value.</description>
<syntax><int/></syntax>
</parameter>
<parameter name="RxAcmProfile" access="readOnly">
<description>RX ACM profile.</description>
<syntax><int/></syntax>
</parameter>
<parameter name="RxSymbolRate" access="readOnly">
<description>RX symbol rate.</description>
<syntax><int/></syntax>
</parameter>
<parameter name="TxAcmProfile" access="readOnly">
<description>TX ACM profile.</description>
<syntax><int/></syntax>
</parameter>
<parameter name="TxSymbolRate" access="readOnly">
<description>TX symbol rate.</description>
<syntax><int/></syntax>
</parameter>
</object>
<object name="Device.X_CATAWAMPUS-ORG.Glaukus.Modem.Transmitter." access="readOnly" minEntries="1" maxEntries="1">
<description>Status of the modem transmitter.</description>
<parameter name="DcLeakageI" access="readOnly">
<syntax><int/></syntax>
</parameter>
<parameter name="DcLeakageQ" access="readOnly">
<syntax><int/></syntax>
</parameter>
<parameter name="Mode" access="readOnly">
<syntax><int/></syntax>
</parameter>
<parameter name="ModeStr" access="readOnly">
<syntax><string/></syntax>
</parameter>
<parameter name="SweepTime" access="readOnly">
<syntax><int/></syntax>
</parameter>
<parameter name="ToneFreq" access="readOnly">
<syntax><int/></syntax>
</parameter>
<parameter name="ToneSecFreq" access="readOnly">
<syntax><int/></syntax>
</parameter>
</object>
<object name="Device.X_CATAWAMPUS-ORG.Glaukus.Modem.ModemVersion." access="readOnly" minEntries="1" maxEntries="1">
<parameter name="Build" access="readOnly">
<syntax><int/></syntax>
</parameter>
<parameter name="ChipType" access="readOnly">
<syntax><string/></syntax>
</parameter>
<parameter name="Major" access="readOnly">
<syntax><int/></syntax>
</parameter>
<parameter name="Minor" access="readOnly">
<syntax><int/></syntax>
</parameter>
</object>
<object name="Device.X_CATAWAMPUS-ORG.Glaukus.Radio." access="readOnly" minentries="1" maxEntries="1">
<description>Container for Glaukus Manager Radio Statistics.</description>
<parameter name="HeaterEnabled" access="readOnly">
<syntax><boolean/></syntax>
</parameter>
<parameter name="PaLnaPowerEnabled" access="readOnly">
<syntax><boolean/></syntax>
</parameter>
<parameter name="PaLnaPowerStatus" access="readOnly">
<syntax><string/></syntax>
</parameter>
<parameter name="TransceiversPowerEnabled" access="readOnly">
<syntax><boolean/></syntax>
</parameter>
</object>
<object name="Device.X_CATAWAMPUS-ORG.Glaukus.Radio.HiTransceiver." access="readOnly" minentries="1" maxEntries="1">
<description>Container for Glaukus Manager Radio HiTransceiver Statistics.</description>
<parameter name="IcModel" access="readOnly">
<syntax><string/></syntax>
</parameter>
<parameter name="Mode" access="readOnly">
<syntax><string/></syntax>
</parameter>
<parameter name="Temp" access="readOnly">
<syntax><int/></syntax>
</parameter>
</object>
<object name="Device.X_CATAWAMPUS-ORG.Glaukus.Radio.HiTransceiver.Epot." access="readOnly" minentries="1" maxEntries="1">
<description>Container for Glaukus Manager Radio HiTransceiver Epot Settings.</description>
<parameter name="Control" access="readOnly">
<syntax><string/></syntax>
</parameter>
<parameter name="Driver" access="readOnly">
<syntax><int/></syntax>
</parameter>
<parameter name="Lna" access="readOnly">
<syntax><int/></syntax>
</parameter>
<parameter name="Pa" access="readOnly">
<syntax><int/></syntax>
</parameter>
</object>
<object name="Device.X_CATAWAMPUS-ORG.Glaukus.Radio.HiTransceiver.Pll." access="readOnly" minentries="1" maxEntries="1">
<description>Container for Glaukus Manager Radio HiTransceiver Pll Settings.</description>
<parameter name="Frequency" access="readOnly">
<syntax><int/></syntax>
</parameter>
<parameter name="LockCounts" access="readOnly">
<syntax><int/></syntax>
</parameter>
<parameter name="Locked" access="readOnly">
<syntax><boolean/></syntax>
</parameter>
</object>
<object name="Device.X_CATAWAMPUS-ORG.Glaukus.Radio.LoTransceiver." access="readOnly" minentries="1" maxEntries="1">
<description>Container for Glaukus Manager Radio LoTransceiver Statistics.</description>
<parameter name="IcModel" access="readOnly">
<syntax><string/></syntax>
</parameter>
<parameter name="Mode" access="readOnly">
<syntax><string/></syntax>
</parameter>
<parameter name="Temp" access="readOnly">
<syntax><int/></syntax>
</parameter>
</object>
<object name="Device.X_CATAWAMPUS-ORG.Glaukus.Radio.LoTransceiver.Epot." access="readOnly" minentries="1" maxEntries="1">
<description>Container for Glaukus Manager Radio LoTransceiver Epot Settings.</description>
<parameter name="Control" access="readOnly">
<syntax><string/></syntax>
</parameter>
<parameter name="Driver" access="readOnly">
<syntax><int/></syntax>
</parameter>
<parameter name="Lna" access="readOnly">
<syntax><int/></syntax>
</parameter>
<parameter name="Pa" access="readOnly">
<syntax><int/></syntax>
</parameter>
</object>
<object name="Device.X_CATAWAMPUS-ORG.Glaukus.Radio.LoTransceiver.Pll." access="readOnly" minentries="1" maxEntries="1">
<description>Container for Glaukus Manager Radio LoTransceiver Pll Statistics.</description>
<parameter name="Frequency" access="readOnly">
<syntax><int/></syntax>
</parameter>
<parameter name="LockCounts" access="readOnly">
<syntax><int/></syntax>
</parameter>
<parameter name="Locked" access="readOnly">
<syntax><boolean/></syntax>
</parameter>
</object>
<object name="Device.X_CATAWAMPUS-ORG.Glaukus.Radio.Rx." access="readOnly" minentries="1" maxEntries="1">
<description>Container for Glaukus Manager Radio RX Statistics.</description>
<parameter name="AgcDigitalGain" access="readOnly">
<syntax><int/></syntax>
</parameter>
<parameter name="AgcDigitalGainIndex" access="readOnly">
<syntax><int/></syntax>
</parameter>
<parameter name="LnaCurrentMeas" access="readOnly">
<syntax><int/></syntax>
</parameter>
<parameter name="LnaCurrentSet" access="readOnly">
<syntax><int/></syntax>
</parameter>
<parameter name="Rssi" access="readOnly">
<syntax><int/></syntax>
</parameter>
</object>
<object name="Device.X_CATAWAMPUS-ORG.Glaukus.Radio.Tx." access="readOnly" minentries="1" maxEntries="1">
<description>Container for Glaukus Manager Radio TX Statistics.</description>
<parameter name="DcI" access="readOnly">
<syntax><int/></syntax>
</parameter>
<parameter name="DcQ" access="readOnly">
<syntax><int/></syntax>
</parameter>
<parameter name="DriverCurrentMeas" access="readOnly">
<syntax><int/></syntax>
</parameter>
<parameter name="DriverCurrentSet" access="readOnly">
<syntax><int/></syntax>
</parameter>
<parameter name="PaCurrentMeas" access="readOnly">
<syntax><int/></syntax>
</parameter>
<parameter name="PaTemp" access="readOnly">
<syntax><int/></syntax>
</parameter>
<parameter name="TxPowerControl" access="readOnly">
<syntax><string/></syntax>
</parameter>
<parameter name="TxPowerMeas" access="readOnly">
<syntax><int/></syntax>
</parameter>
<parameter name="TxPowerSet" access="readOnly">
<syntax><int/></syntax>
</parameter>
<parameter name="VgaGain" access="readOnly">
<syntax><int/></syntax>
</parameter>
</object>
<object name="Device.X_CATAWAMPUS-ORG.Glaukus.Radio.Version." access="readOnly" minEntries="1" maxEntries="1"/>
<object name="Device.X_CATAWAMPUS-ORG.Glaukus.Radio.Version.Hardware." access="readOnly" minentries="1" maxEntries="1">
<description>Container for Glaukus Manager Radio Hardware Version Information.</description>
<parameter name="Major" access="readOnly">
<syntax><int/></syntax>
</parameter>
<parameter name="Minor" access="readOnly">
<syntax><int/></syntax>
</parameter>
<parameter name="Type" access="readOnly">
<syntax><string/></syntax>
</parameter>
</object>
<object name="Device.X_CATAWAMPUS-ORG.Glaukus.Radio.Version.Software." access="readOnly" minentries="1" maxEntries="1">
<description>Container for Glaukus Manager Radio Hardware Version Information.</description>
<parameter name="Build" access="readOnly">
<syntax><int/></syntax>
</parameter>
<parameter name="Major" access="readOnly">
<syntax><int/></syntax>
</parameter>
<parameter name="Minor" access="readOnly">
<syntax><int/></syntax>
</parameter>
</object>
<object name="Device.X_CATAWAMPUS-ORG.WispNetManagement." access="readWrite" minEntries="1" maxEntries="1">
<description>Container for general networking manager configuration for Wireless Service Provider products.</description>
<parameter name="Configuration" access="readWrite">
<description>Write to this parameter will trigger configuration change. It is a JSON string that controls configuration (e.g. QoS, Radio,...)</description>
<syntax><string/></syntax>
</parameter>
</object>
</model>
</dm:document>