Appendix A: Subscriber Settings DTO Schema
The following content describes all supported application DTO Schemas.
NOTE:
Properties beginning with Global. are immutable and are the same for every device in the system.
Properties beginning with Settings can be set on a per-device basis, and can be subject to validation rules.
Access Control (AccessControl)
| Property | Type |
|---|---|
| Global.DeviceConfiguration.ModuleConfigurations.{}.AccessControl.ControlLists.{}.IPAddress | string |
| Global.DeviceConfiguration.ModuleConfigurations.{}.AccessControl.ControlLists.{}.SubnetMask | string |
| Global.DeviceConfiguration.ModuleConfigurations.{}.AccessControl.FTP | string |
| Global.DeviceConfiguration.ModuleConfigurations.{}.AccessControl.HTTP | string |
| Global.DeviceConfiguration.ModuleConfigurations.{}.AccessControl.ICMP | string |
| Global.DeviceConfiguration.ModuleConfigurations.{}.AccessControl.SNMP | string |
| Global.DeviceConfiguration.ModuleConfigurations.{}.AccessControl.SSH | string |
| Global.DeviceConfiguration.ModuleConfigurations.{}.AccessControl.TFTP | string |
| Global.DeviceConfiguration.ModuleConfigurations.{}.AccessControl.Telnet | string |
Captive Portal (CAPO)
| Property | Type |
|---|---|
| Global.CaptivePortal.WithoutSubscriber.ActiveConfiguration | string |
| Global.CaptivePortals.{}.AllowList | string |
| Global.CaptivePortals.{}.CaptivePortalURL | string |
| Global.CaptivePortals.{}.Name | string |
| Settings.CaptivePortal.ActiveConfiguration | string |
| Settings.CaptivePortal.Status | string |
| Settings.CaptivePortal.URLAddress | string |
Click Through (ClickThrough)
| Property | Type |
|---|---|
| Settings.ClickThrough.ExpirationDate | string |
| Settings.ClickThrough.IP | string |
| Settings.ClickThrough.IsEnabled | string |
| Settings.ClickThrough.Port | string |
Control Panel (ControlPanel)
| Property | Type |
|---|---|
| Global.DeviceConfiguration.ModuleConfigurations.{}.ControlPanel.RedirectURL | string |
Device Info (DeviceInfo)
| Property | Type |
|---|---|
| Settings.DeviceInfo.DSL.AttenuationDown | string |
| Settings.DeviceInfo.DSL.AttenuationUp | string |
| Settings.DeviceInfo.DSL.CurrentRateDown | string |
| Settings.DeviceInfo.DSL.CurrentRateUp | string |
| Settings.DeviceInfo.DSL.MaxBitRateDown | string |
| Settings.DeviceInfo.DSL.MaxBitRateUp | string |
| Settings.DeviceInfo.DSL.MaxRateDown | string |
| Settings.DeviceInfo.DSL.MaxRateUp | string |
| Settings.DeviceInfo.DSL.PowerDown | string |
| Settings.DeviceInfo.DSL.PowerUp | string |
| Settings.DeviceInfo.DSL.SNRDown | string |
| Settings.DeviceInfo.DSL.SNRUp | string |
| Settings.DeviceInfo.DSL.ThroughputDown | string |
| Settings.DeviceInfo.DSL.ThroughputUp | string |
Device Statistics (DeviceStats)
| Property | Type |
|---|---|
| Settings.DeviceStats.DSLErrors.CRC | unsignedInt |
| Settings.DeviceStats.DSLErrors.CellDelin | unsignedInt |
| Settings.DeviceStats.DSLErrors.Down.BitErrors | unsignedInt |
| Settings.DeviceStats.DSLErrors.Down.Blocks | unsignedInt |
| Settings.DeviceStats.DSLErrors.Down.CRC | unsignedInt |
| Settings.DeviceStats.DSLErrors.Down.FEC | unsignedInt |
| Settings.DeviceStats.DSLErrors.Down.HEC | unsignedInt |
| Settings.DeviceStats.DSLErrors.Down.RsCorrectable | unsignedInt |
| Settings.DeviceStats.DSLErrors.Down.RsUncorrectable | unsignedInt |
| Settings.DeviceStats.DSLErrors.Down.Seconds | unsignedInt |
| Settings.DeviceStats.DSLErrors.Down.SevereSeconds | unsignedInt |
| Settings.DeviceStats.DSLErrors.FEC | unsignedInt |
| Settings.DeviceStats.DSLErrors.HEC | unsignedInt |
| Settings.DeviceStats.DSLErrors.Init | unsignedInt |
| Settings.DeviceStats.DSLErrors.InitTimeouts | unsignedInt |
| Settings.DeviceStats.DSLErrors.LinkRetrain | unsignedInt |
| Settings.DeviceStats.DSLErrors.LossOfFraming | unsignedInt |
| Settings.DeviceStats.DSLErrors.Seconds | unsignedInt |
| Settings.DeviceStats.DSLErrors.SevereSeconds | unsignedInt |
| Settings.DeviceStats.DSLErrors.Up.BitErrors | unsignedInt |
| Settings.DeviceStats.DSLErrors.Up.Blocks | unsignedInt |
| Settings.DeviceStats.DSLErrors.Up.CRC | unsignedInt |
| Settings.DeviceStats.DSLErrors.Up.FEC | unsignedInt |
| Settings.DeviceStats.DSLErrors.Up.HEC | unsignedInt |
| Settings.DeviceStats.DSLErrors.Up.RsCorrectable | unsignedInt |
| Settings.DeviceStats.DSLErrors.Up.RsUncorrectable | unsignedInt |
| Settings.DeviceStats.DSLErrors.Up.Seconds | unsignedInt |
| Settings.DeviceStats.DSLErrors.Up.SevereSeconds | unsignedInt |
| Settings.DeviceStats.WANInterfaces.{}.Ifref | string |
| Settings.DeviceStats.WANInterfaces.{}.Receive.Bytes | unsignedInt |
| Settings.DeviceStats.WANInterfaces.{}.Receive.Drops | unsignedInt |
| Settings.DeviceStats.WANInterfaces.{}.Receive.Errors | unsignedInt |
| Settings.DeviceStats.WANInterfaces.{}.Receive.Packets | unsignedInt |
| Settings.DeviceStats.WANInterfaces.{}.Transmit.Bytes | unsignedInt |
| Settings.DeviceStats.WANInterfaces.{}.Transmit.Drops | unsignedInt |
| Settings.DeviceStats.WANInterfaces.{}.Transmit.Errors | unsignedInt |
| Settings.DeviceStats.WANInterfaces.{}.Transmit.Packets | unsignedInt |
LAN Hosts Information (Hosts)
| Property | Type |
|---|---|
| Settings.Hosts.{}.Active | boolean |
| Settings.Hosts.{}.Alias | string |
| Settings.Hosts.{}.CurrentIPAddress | string |
| Settings.Hosts.{}.Icon | string |
| Settings.Hosts.{}.InterfaceType | string |
| Settings.Hosts.{}.IsStaticIpAddress | string |
| Settings.Hosts.{}.MACAddress | string |
| Settings.Hosts.{}.Manufacturer | string |
| Settings.Hosts.{}.StaticIPAddress | string |
| Settings.Hosts.{}.Wlan.RateFromHost | unsignedInt |
| Settings.Hosts.{}.Wlan.RateToHost | unsignedInt |
| Settings.Hosts.{}.Wlan.Standard | string |
| Settings.Hosts.{}.Wlan.Strength | string |
LAN (LAN)
| Property | Type |
|---|---|
| Global.DeviceConfiguration.ModuleConfigurations.{}.LAN.DHCPMaxAddress | string |
| Global.DeviceConfiguration.ModuleConfigurations.{}.LAN.DHCPMinAddress | string |
| Global.DeviceConfiguration.ModuleConfigurations.{}.LAN.NetworkAddress | string |
| Global.DeviceConfiguration.ModuleConfigurations.{}.LAN.SubnetMask | string |
Management Password (ManagementPassword)
| Property | Type |
|---|---|
| Global.DeviceConfiguration.ModuleConfigurations.{}.ManagementPasswords.AdminPassword | string |
| Global.DeviceConfiguration.ModuleConfigurations.{}.ManagementPasswords.SupportPassword | string |
Management Server (ManagementServer)
| Property | Type |
|---|---|
| Global.DeviceConfiguration.ModuleConfigurations. {}.ManagementServer.ConnectionRequestPassword | string |
| Global.DeviceConfiguration.ModuleConfigurations. {}.ManagementServer.ConnectionRequestUsername | string |
| Global.DeviceConfiguration.ModuleConfigurations. {}.ManagementServer.PeriodicInformInterval | unsignedInt |
| Settings.ManagementServer.ConnectionRequestPassword | string |
| Settings.ManagementServer.ConnectionRequestUsername | string |
| Settings.ManagementServer.PeriodicInformInterval | string |
Management Server Status (ManagementServerStatus)
| Property | Type |
|---|---|
| Settings.ManagementServerStatus.PeriodicInformInterval | unsignedInt |
Notifications (NTFY)
| Property | Type |
|---|---|
| Global.ParameterAttributes.{}.Name | string |
| Global.ParameterAttributes.{}.Parameters.{}.Notification | int |
| Global.ParameterAttributes.{}.Parameters.{}.PathSelector | string |
Port Forward (PF)
| Property | Type |
|---|---|
| Settings.PortForwards.{}.Description | string |
| Settings.PortForwards.{}.EndPort | unsignedInt |
| Settings.PortForwards.{}.IPAddress | string |
| Settings.PortForwards.{}.InternalPort | unsignedInt |
| Settings.PortForwards.{}.Managed | string |
| Settings.PortForwards.{}.Protocol | string |
| Settings.PortForwards.{}.StartPort | unsignedInt |
PPP (PPP)
| Property | Type |
|---|---|
| Settings.WANPPPConnections.{}.Password | string |
| Settings.WANPPPConnections.{}.TR098Path | string |
| Settings.WANPPPConnections.{}.Username | string |
Quality of Service (QoS)
| Property | Type |
|---|---|
| Global.QoS.Profiles.{}.Classifications.{}.Criteria.DSCP | string |
| Global.QoS.Profiles.{}.Classifications.{}.Criteria.DestinationIP | string |
| Global.QoS.Profiles.{}.Classifications.{}.Criteria.DestinationIPMask | string |
| Global.QoS.Profiles.{}.Classifications.{}.Criteria.DestinationMAC | string |
| Global.QoS.Profiles.{}.Classifications.{}.Criteria.DestinationMACMask | string |
| Global.QoS.Profiles.{}.Classifications.{}.Criteria.DestinationPort | int |
| Global.QoS.Profiles.{}.Classifications.{}.Criteria.EtherType | string |
| Global.QoS.Profiles.{}.Classifications.{}.Criteria.EthernetPriority | int |
| Global.QoS.Profiles.{}.Classifications.{}.Criteria.Interface | string |
| Global.QoS.Profiles.{}.Classifications.{}.Criteria.Protocol | string |
| Global.QoS.Profiles.{}.Classifications.{}.Criteria.SourceIP | string |
| Global.QoS.Profiles.{}.Classifications.{}.Criteria.SourceIPMask | string |
| Global.QoS.Profiles.{}.Classifications.{}.Criteria.SourceMAC | string |
| Global.QoS.Profiles.{}.Classifications.{}.Criteria.SourceMACMask | string |
| Global.QoS.Profiles.{}.Classifications.{}.Criteria.SourcePort | int |
| Global.QoS.Profiles.{}.Classifications.{}.Criteria.VLAN | int |
| Global.QoS.Profiles.{}.Classifications.{}.Enable | boolean |
| Global.QoS.Profiles.{}.Classifications.{}.Name | string |
| Global.QoS.Profiles.{}.Classifications.{}.Order | unsignedInt |
| Global.QoS.Profiles.{}.Classifications.{}.Result.DSCP | string |
| Global.QoS.Profiles.{}.Classifications.{}.Result.EthernetPriority | int |
| Global.QoS.Profiles.{}.Classifications.{}.Result.Queue | string |
| Global.QoS.Profiles.{}.Classifications.{}.Result.VLAN | int |
| Global.QoS.Profiles.{}.Name | string |
| Global.QoS.Profiles.{}.Queues.{}.Enable | boolean |
| Global.QoS.Profiles.{}.Queues.{}.Interface | string |
| Global.QoS.Profiles.{}.Queues.{}.Latency | string |
| Global.QoS.Profiles.{}.Queues.{}.Name | string |
| Global.QoS.Profiles.{}.Queues.{}.Precedence | unsignedInt |
| Settings.QoS.ManagedProfiles.{}.Active | boolean |
| Settings.QoS.ManagedProfiles.{}.Name | string |
Static Reservation (SR)
| Property | Type |
|---|---|
| Settings.DHCPStaticReservations.{}.IPAddress | string |
| Settings.DHCPStaticReservations.{}.MACAddress | string |
| Settings.DHCPStaticReservations.{}.Managed | string |
STUN (STUN)
| Property | Type |
|---|---|
| Global.DeviceConfiguration.ModuleConfigurations.{}.STUN.MaximumKeepAlivePeriod | int |
| Global.DeviceConfiguration.ModuleConfigurations.{}.STUN.MinimumKeepAlivePeriod | unsignedInt |
| Global.DeviceConfiguration.ModuleConfigurations.{}.STUN.ServerAddress | string |
| Global.DeviceConfiguration.ModuleConfigurations.{}.STUN.ServerPort | unsignedInt |
Static Route (StaticRoute)
| Property | Type |
|---|---|
| Global.Routing.DefaultActiveProfileName | string |
| Global.Routing.Profiles.{}.DefaultConnectionService | string |
| Global.Routing.Profiles.{}.Forwards.{}.DestinationIP | string |
| Global.Routing.Profiles.{}.Forwards.{}.DestinationSubnet | string |
| Global.Routing.Profiles.{}.Forwards.{}.Enable | boolean |
| Global.Routing.Profiles.{}.Forwards.{}.GatewayIP | string |
| Global.Routing.Profiles.{}.Forwards.{}.Interface | string |
| Global.Routing.Profiles.{}.Name | string |
| Settings.Routing.ManagedProfiles.{}.Active | boolean |
| Settings.Routing.ManagedProfiles.{}.Name | string |
Topology (TOPO)
| Property | Type |
|---|---|
| Global.Topology.AvailableWANConnections.{}.BridgedDSL.Encapsulation | string |
| Global.Topology.AvailableWANConnections.{}.BridgedDSL.IGMPEnabled | boolean |
| Global.Topology.AvailableWANConnections.{}.BridgedDSL.Protocol | unsignedInt |
| Global.Topology.AvailableWANConnections.{}.BridgedDSL.VCI | unsignedInt |
| Global.Topology.AvailableWANConnections.{}.BridgedDSL.VPI | unsignedInt |
| Global.Topology.AvailableWANConnections.{}.BridgedDSL.WANDevice | string |
| Global.Topology.AvailableWANConnections.{}.BridgedEthernet.IGMPEnabled | boolean |
| Global.Topology.AvailableWANConnections.{}.BridgedEthernet.VLAN8021P | unsignedInt |
| Global.Topology.AvailableWANConnections.{}.BridgedEthernet.VLANID | unsignedInt |
| Global.Topology.AvailableWANConnections.{}.Name | string |
| Global.Topology.AvailableWANConnections.{}.Order | int |
| Global.Topology.AvailableWANConnections.{}.Type | string |
| Global.Topology.Configurations.{}.Bridging.IGMP.Enabled | boolean |
| Global.Topology.Configurations.{}.Bridging.IGMP.Mode | string |
| Global.Topology.Configurations.{}.Bridging.LANPortBridges.{}.Ports | string |
| Global.Topology.Configurations.{}.Bridging.LANPortBridges.{}.WANConnectionName | string |
| Global.Topology.Configurations.{}.Name | string |
| Settings.Topology.ActiveConfigurations.{}.Name | string |
Time Zone (TZ)
| Property | Type |
|---|---|
| Global.TimeZones.{}.Display.{}.Description | string |
| Global.TimeZones.{}.Display.{}.Language | string |
| Global.TimeZones.{}.Order | unsignedInt |
| Global.TimeZones.{}.TimeZone | string |
| Global.TimeZones.{}.ZoneRules | string |
| Settings.Time.LocalTimeZoneName | string |
Universal Device Management (UDM)
| Property | Type |
|---|---|
| Settings.UniversalDeviceManagement.Hosts.{}.ExternalPort | unsignedInt |
| Settings.UniversalDeviceManagement.Hosts.{}.InternalPort | unsignedInt |
| Settings.UniversalDeviceManagement.Hosts.{}.MACAddress | string |
| Settings.UniversalDeviceManagement.Hosts.{}.Path | string |
| Settings.UniversalDeviceManagement.Hosts.{}.Status | string |
Voice Over IP (VoIP)
| Property | Type |
|---|---|
| Settings.VoIP.VoiceProfile.Line.{}.Enable | string |
| Settings.VoIP.VoiceProfile.Line.{}.SIP.AuthPassword | string |
| Settings.VoIP.VoiceProfile.Line.{}.SIP.AuthUserName | string |
| Settings.VoIP.VoiceProfile.Line.{}.SIP.URI | string |
| Settings.VoIP.VoiceProfile.SIP.OutboundProxy | string |
| Settings.VoIP.VoiceProfile.SIP.OutboundProxyPort | unsignedInt |
| Settings.VoIP.VoiceProfile.SIP.ProxyServer | string |
| Settings.VoIP.VoiceProfile.SIP.ProxyServerPort | unsignedInt |
| Settings.VoIP.VoiceProfile.SIP.RegistrarServer | string |
| Settings.VoIP.VoiceProfile.SIP.RegistrarServerPort | unsignedInt |
| Settings.VoIP.VoiceProfile.SIP.RegistrationPeriod | unsignedInt |
| Settings.VoIP.VoiceProfile.SIP.WANInterface | string |
WAN v2 (WAN2)
| Property | Type |
|---|---|
| Global.WAN.ManagedWANConnections.{}.Addressing.Static.Address | string |
| Global.WAN.ManagedWANConnections.{}.Addressing.Static.DNSServers | string |
| Global.WAN.ManagedWANConnections.{}.Addressing.Static.Gateway | string |
| Global.WAN.ManagedWANConnections.{}.Addressing.Static.SubnetMask | string |
| Global.WAN.ManagedWANConnections.{}.ConnectionType | string |
| Global.WAN.ManagedWANConnections.{}.FirewallEnabled | boolean |
| Global.WAN.ManagedWANConnections.{}.IGMPEnabled | boolean |
| Global.WAN.ManagedWANConnections.{}.Link.DSL.Encapsulation | string |
| Global.WAN.ManagedWANConnections.{}.Link.DSL.LinkType | string |
| Global.WAN.ManagedWANConnections.{}.Link.DSL.QoSEnabled | boolean |
| Global.WAN.ManagedWANConnections.{}.Link.DSL.VCI | unsignedInt |
| Global.WAN.ManagedWANConnections.{}.Link.DSL.VPI | unsignedInt |
| Global.WAN.ManagedWANConnections.{}.Link.Type | string |
| Global.WAN.ManagedWANConnections.{}.NATEnabled | boolean |
| Global.WAN.ManagedWANConnections.{}.Name | string |
| Global.WAN.ManagedWANConnections.{}.PPPConnection.Password | string |
| Global.WAN.ManagedWANConnections.{}.PPPConnection.Username | string |
| Global.WAN.ManagedWANConnections.{}.Type | string |
| Global.WAN.ManagedWANConnections.{}.VLAN8021p | unsignedInt |
| Global.WAN.ManagedWANConnections.{}.VLANID | unsignedInt |
| Global.WAN.Profiles.{}.ManagedWANConnections.{}.Name | string |
| Global.WAN.Profiles.{}.Name | string |
| Settings.WAN.ManagedProfiles.{}.Active | boolean |
| Settings.WAN.ManagedProfiles.{}.Name | string |
WAN Device Information (WANDevices)
| Property | Type |
|---|---|
| Settings.WANDevices.ActiveWanDevice | unsignedInt |
| Settings.WANDevices.WANType | string |
Wan Interface Information (WANInterfaces)
| Property | Type |
|---|---|
| Settings.WANInterfaces.DefaultIP | string |
| Settings.WANInterfaces.DefaultPort | string |
| Settings.WANInterfaces.Interfaces.{}.AccessType | string |
| Settings.WANInterfaces.Interfaces.{}.AddressingType | string |
| Settings.WANInterfaces.Interfaces.{}.ConnectionType | string |
| Settings.WANInterfaces.Interfaces.{}.ExternalIPAddress | string |
| Settings.WANInterfaces.Interfaces.{}.Id | unsignedInt |
| Settings.WANInterfaces.Interfaces.{}.Ifref | string |
| Settings.WANInterfaces.Interfaces.{}.LinkAddress | string |
| Settings.WANInterfaces.Interfaces.{}.LinkVLANId | string |
| Settings.WANInterfaces.Interfaces.{}.TR069Path | string |
Wireless (WIFI)
| Property | Type |
|---|---|
| Settings.Factory.WLANConfigurations.{}.Id | string |
| Settings.Factory.WLANConfigurations.{}.SSID | string |
| Settings.WLANConfigurations.{}.BeaconAdvertisementEnabled | boolean |
| Settings.WLANConfigurations.{}.BeaconType | string |
| Settings.WLANConfigurations.{}.Channel | int |
| Settings.WLANConfigurations.{}.Enable | boolean |
| Settings.WLANConfigurations.{}.Id | string |
| Settings.WLANConfigurations.{}.IsPrimary | string |
| Settings.WLANConfigurations.{}.SSID | string |
| Settings.WLANConfigurations.{}.Secret | string |