Jump to content
  • EN

RUTM08 TR-069

From Teltonika Networks Wiki
Main Page > RUTM Routers > RUTM08 > RUTM08 Manual > RUTM08 WebUI > RUTM08 Services section > RUTM08 TR-069


Summary

TR-069 (Technical Report 069) is an application layer protocol designed for management of equipment connected to a remote network.

This chapter of the user manual provides an overview of the UPnP page in RUTM08 devices.

TR-069 is additional software that can be installed from the System → Package Manager page.

TR-069 Client Configuration

Field Value Description
Enable off | on; default: off Turns TR-069 client on or off.
Periodic enable off | on; default: on Enables TR-069 client periodic data transmission to TR-069 server.
Accept server request off | on; default: off When enabled the device accepts connection requests from servers.
Sending interval integer [60..9999999]; default: 100 Periodic data transmission frequency (in seconds).
Username string; default: easycwmp Username used for authentication to a TR-069 server.
Password string; default: easycwmp Password used for authentication to a TR-069 server.
URL host | ip; default: http://192.168.1.110:8080/openacs/acs IP address or hostname of a TR-069 server.
Use secure connection off | on; default: off Enable TLS for a secure connection. Requires certificate files. TLS works only if the URL starts with https://. For improved security it is advised to enable secure connection.
Use certificate files from device off | on; default: off Choose this option if you want to select certificate files from device.
Certificate authority file CA file Upload the Certificate Authority (CA) file. Required for verifying the server's certificate.
Client certificate .crt file Upload the client certificate file. This is used for client authentication by the server.
Client private keyfile .key file Upload the client private key file. This is used along with the client certificate for authentication.

Management via TR-069

TR-069 can be used to set or get values from RUT devices. Below is a list of commands used for device management via TR-069.

  • R - read only;
  • RW - read/write;
  • string(64) - 64 bit string;
  • string(256) - 256 bit string;
  • unsignedInt - integer storing only positive values.

Device Information:

  1. DeviceInfo.HardwareVersion - device hardware version (e.g., 0201) R
  2. DeviceInfo.Manufacturer - device manufacturer (e.g., Teltonika) R
  3. DeviceInfo.ManufacturerOUI - organizationally unique identifier of the device manufacture (e.g., 001E42) R
  4. DeviceInfo.ProductClass - device model (e.g., RUTM08) R
  5. DeviceInfo.ProvisioningCode - provisioning code R
  6. DeviceInfo.SerialNumber - device serial number (e.g., 1000111111) R
  7. DeviceInfo.SoftwareVersion - device software version (e.g., RUTM_R_00.0X.XX) R
  8. DeviceInfo.SpecVersion - device special version (e.g., 1.0) R

Device IP Interface information:

  1. IP.Interface.{i}.Enable - Enables or disables the interface R
  2. IP.Interface.{i}.Name - The textual name of the interface as assigned by the CPE R
  3. IP.Interface.{i}.Type - IP interface type R
  4. IP.Interface.{i}.IPv4AddressNumberOfEntries - R
  5. IP.Interface.{i}.IPv4Address.{i}.IPAddress - IPv4 address (e.g., 192.168.1.1) RW
  6. IP.Interface.{i}.IPv4Address.{i}.AddressingType - Addressing method used to assign the IP address R
  7. IP.Interface.{i}.IPv4Address.{i}.Enable - Enables or disables this IPv4 address R
  8. IP.Interface.{i}.IPv4Address.{i}.SubnetMask - Subnet mask R
  9. IP.Interface.{i}.Stats.BytesSent - The total number of bytes transmitted out of the interface, including framing characters R
  10. IP.Interface.{i}.Stats.BytesReceived - The total number of bytes received on the interface, including framing characters R
  11. IP.Interface.{i}.Stats.PacketsSent - The total number of packets transmitted out of the interface R
  12. IP.Interface.{i}.Stats.PacketsReceived - The total number of packets received on the interface R
  13. IP.Interface.{i}.Stats.ErrorsSent - The total number of outbound packets that could not be transmitted because of errors R
  14. IP.Interface.{i}.Stats.ErrorsReceived - The total number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol R
  15. IP.Interface.{i}.Stats.DiscardPacketsSent - The total number of outbound packets which were chosen to be discarded even though no errors had been detected to prevent their being transmitted. One possible reason for discarding such a packet could be to free up buffer space R
  16. IP.Interface.{i}.Stats.DiscardPacketsReceived - The total number of inbound packets which were chosen to be discarded even though no errors had been detected to prevent their being delivered. One possible reason for discarding such a packet could be to free up buffer space R

Device IP Diagnostics information:

  1. IP.Diagnostics.IPPing.DiagnosticsState - Controls and indicates the state of the ping test RW
  2. IP.Diagnostics.IPPing.Host - Specifies the target hostname or IP address to ping RW
  3. IP.Diagnostics.IPPing.NumberOfRepetitions - Defines how many ICMP echo requests will be sent during the test RW
  4. IP.Diagnostics.IPPing.Timeout - Maximum time in milliseconds to wait for each ping response before considering it failed RW
  5. IP.Diagnostics.IPPing.DataBlockSize - Size in bytes of the payload in each ping packet RW
  6. IP.Diagnostics.IPPing.SuccessCount - Number of ping requests that received a successful reply R
  7. IP.Diagnostics.IPPing.FailureCount - Number of ping requests that failed or timed out; typically calculated as total minus successful responses RW
  8. IP.Diagnostics.IPPing.AverageResponseTime - Average round-trip time of all successful ping responses, in milliseconds R
  9. IP.Diagnostics.IPPing.MinimumResponseTime - Shortest round-trip time recorded during the test, in milliseconds R
  10. IP.Diagnostics.IPPing.MaximumResponseTime - Longest round-trip time recorded during the test, in milliseconds R

Device NAT Port Mapping information:

  1. NAT.PortMapping.{i}.Enable - Enables or disables the port mapping instance. On creation, an entry is disabled by default RW
  2. NAT.PortMapping.{i}.Status - R
  3. NAT.PortMapping.{i}.Origin - Indicates the Origin of the PortMapping instance R
  4. NAT.PortMapping.{i}.LeaseDuration - Determines the time to live, in seconds, of a port mapping lease, where "time to live" means the number of seconds before the port mapping expires RW
  5. NAT.PortMapping.{i}.RemainingLeaseTime - For a dynamic (non-static) port mapping, when this parameter is read, the value represents the time (in seconds) remaining on the port mapping lease. That is, for a dynamic port mapping, the value counts down toward 0. When a dynamic port mapping lease expires, the device MUST automatically terminate that port mapping, and MUST automatically delete the corresponding PortMapping table entry R
  6. NAT.PortMapping.{i}.RemoteHost - This parameter is the IP address of the source of inbound packets. An empty string indicates a "wildcard", i.e. any IP address (this will be an empty string in most cases). CPE are REQUIRED only to support an empty string RW
  7. NAT.PortMapping.{i}.ExternalPort - The external port (or the first port of a range of external ports) that the NAT gateway would listen on for traffic to a corresponding InternalPort. Inbound packets to this external port on the WAN interface SHOULD be forwarded to the IP.Interface associated with the InternalClient on the InternalPort RW
  8. NAT.PortMapping.{i}.ExternalPortEndRange - Indicates the last port of the external port range that starts with ExternalPort RW
  9. NAT.PortMapping.{i}.InternalPort - The port on InternalClient that the gateway SHOULD forward traffic to RW
  10. NAT.PortMapping.{i}.Protocol - The protocol of the port mapping RW
  11. NAT.PortMapping.{i}.InternalClient - The IP address or DNS host name of an internal client (on the LAN) RW
  12. NAT.PortMapping.{i}.Description - User-readable description of this port mapping RW

Device Management Server information:

  1. ManagementServer.ConnectionRequestPassword - connection request password (e.g., randompassword) RW
  2. ManagementServer.ConnectionRequestURL - connection request URL R
  3. ManagementServer.ConnectionRequestUsername - connection request username (e.g., 001E42-RUTX14-0000000000) RW
  4. ManagementServer.ParameterKey - server parameter key R
  5. ManagementServer.Password - server password RW
  6. ManagementServer.PeriodicInformEnable - enabled/disabled TR-069 client periodic data transmission to TR-069 server (e.g., true) RW
  7. ManagementServer.PeriodicInformInterval - periodic data transmission interval (e.g., 300) RW
  8. ManagementServer.PeriodicInformTime - periodic information time (e.g., 1/1/1970, 8:09:27 PM) RW
  9. ManagementServer.URL - server URL RW
  10. ManagementServer.Username - server username RW

Device ID information:

  1. DeviceID.ID - device ID (e.g., 001E42-RUTX14-0000000000) R
  2. DeviceID.Manufacturer - device manufacturer (e.g., Teltonika) R
  3. DeviceID.OUI - organizationally unique identifier of the device manufacture (e.g., 001E42) R
  4. DeviceID.ProductClass - product class (e.g., RUTXXX) R
  5. DeviceID.SerialNumber - device serial number R

Events information:

  1. Events.0_BOOTSTRAP - bootstrap time R
  2. Events.1_BOOT - boot time R
  3. Events.Inform - information time R
  4. Events.Registered - events reg time R

Device DHCPv4 information:

  1. DHCPv4.Server.Pool.{i}.Enable - Enables or disables the Pool entry RW
  2. DHCPv4.Server.Pool.{i}.Status - The status of this entry R
  3. DHCPv4.Server.Pool.{i}.Interface - The IP Interface associated with the Pool entry RW
  4. DHCPv4.Server.Pool.{i}.MinAddress - Specifies first IPv4 address in the pool to be assigned by the DHCP server on the LAN interface RW
  5. DHCPv4.Server.Pool.{i}.MaxAddress - Specifies last IPv4 address in the pool to be assigned by the DHCP server on the LAN interface RW
  6. DHCPv4.Server.Pool.{i}.SubnetMask - Specifies the client's network subnet mask RW
  7. DHCPv4.Server.Pool.{i}.DNSServers - Comma-separated list (up to 4 items) (length ) of IPv4Addresses. List items represent DNS servers offered to DHCP clients. Support for more than three DNS Servers is OPTIONAL RW
  8. DHCPv4.Server.Pool.{i}.IPRouters - Comma-separated list (up to 4 items) (length ) of IPv4Addresses. List items represent addresses of routers on this subnet. Also known as default gateway. Support for more than one Router address is OPTIONAL RW
  9. DHCPv4.Server.Pool.{i}.LeaseTime - Specifies the lease time in seconds of client assigned addresses. A value of -1 indicates an infinite lease RW

Device IP TraceRoute information:

  1. Device.IP.Diagnostics.TraceRoute.DiagnosticsState- Indicates the availability of diagnostics data. W
  2. Device.IP.Diagnostics.TraceRoute.Interface - Specifies the interface to be used for the trace route test. W
  3. Device.IP.Diagnostics.TraceRoute.ProtocolVersion - Indicates the IP protocol to be used. W
  4. Device.IP.Diagnostics.TraceRoute.Host - Host name or address of the host to find a route to. W
  5. Device.IP.Diagnostics.TraceRoute.NumberOfTries - Number of tries per hop. W
  6. Device.IP.Diagnostics.TraceRoute.Timeout - Timeout in seconds for each hop of the trace route test. W
  7. Device.IP.Diagnostics.TraceRoute.DSCP - DiffServ codepoint to be used for the test packets. W
  8. Device.IP.Diagnostics.TraceRoute.MaxHopCount - The maximum number of hop used in outgoing probe packets (max TTL). W
  9. Device.IP.Diagnostics.TraceRoute.IPAddressUsed - Indicates which IP address was used for TraceRoute. R
  10. Device.IP.Diagnostics.TraceRoute.ResponseTime - Result parameter indicating the response time in seconds the most recent trace route test. R

Device VLAN information:

  1. Device.VLAN.PortBasedNumberOfEntries - Number of Port Based VLAN entries. R
  2. Device.VLAN.InterfaceBasedNumberOfEntries - Number of Interface Based VLAN entries. R
  3. Device.VLAN.PortBased.{i}.VID - VLAN Identification number. W
  4. Device.VLAN.PortBased.{i}.LAN1 - State of LAN port 1: off, untagged, or tagged. W
  5. Device.VLAN.PortBased.{i}.LAN2 - State of LAN port 2: off, untagged, or tagged. W
  6. Device.VLAN.PortBased.{i}.LAN3 - State of LAN port 3: off, untagged, or tagged. W
  7. Device.VLAN.PortBased.{i}.LAN4 - State of LAN port 4: off, untagged, or tagged. W
  8. Device.VLAN.PortBased.{i}.WAN - State of WAN port: off, untagged, or tagged. W
  9. Device.VLAN.InterfaceBased.{i}.Name - Name of the VLAN device. R
  10. Device.VLAN.InterfaceBased.{i}.VID - VLAN tag for this device. W
  11. Device.VLAN.InterfaceBased.{i}.Interface - Ethernet interface this VLAN device is attached to (e.g. eth0). W
  12. Device.VLAN.InterfaceBased.{i}.Type - VLAN type: 802.1Q or 802.1AD. W
  13. Device.VLAN.InterfaceBased.{i}.DeviceNumberOfEntries - Number of Q-in-Q devices under this VLAN. R
  14. Device.VLAN.InterfaceBased.{i}.Device.{j}.Name - Name of the Q-in-Q device. R
  15. Device.VLAN.InterfaceBased.{i}.Device.{j}.VID - 802.1Q tag for the Q-in-Q device. W
  16. Device.VLAN.InterfaceBased.{i}.Device.{j}.Interface - Parent interface the Q-in-Q device is tagged on top of. W

Device Firewall information:

  1. Device.Firewall.Zone - Custom object, representing firewall zones according to Teltonika API. W
  2. Device.Firewall.Zone.{i}.Rule.{j} - Custom object representing a firewall rule within a firewall zone. Each rule defines packet-matching criteria and the action to be performed on matching traffic. W
  3. Device.Firewall.Zone.{i}.Rule.{j}.Enable - Enables or disables the firewall rule. W
  4. Device.Firewall.Zone.{i}.Rule.{j}.Status - Status of the firewall rule. Possible values indicate whether the rule is disabled, enabled, or incorrectly configured. R
  5. Device.Firewall.Zone.{i}.Rule.{j}.Order - Defines the rule precedence. A lower order value has higher precedence and is evaluated first. W
  6. Device.Firewall.Zone.{i}.Rule.{j}.Description - Description of the firewall rule. W
  7. Device.Firewall.Zone.{i}.Rule.{j}.Target - Defines the action performed when traffic matches the rule, such as Accept, Reject, or Drop. W
  8. Device.Firewall.Zone.{i}.Rule.{j}.LogRef - Reference to the firewall logging configuration associated with the rule. W
  9. Device.Firewall.Zone.{i}.Rule.{j}.ExpiryDate - Defines the date and time when the firewall rule should expire. W
  10. Device.Firewall.Zone.{i}.Rule.{j}.DestZone - Defines the destination firewall zone to which the rule applies. W
  11. Device.Firewall.Zone.{i}.Rule.{j}.DestAllZones - Specifies whether the rule applies to traffic destined for all firewall zones.
  12. Device.Firewall.Zone.{i}.Rule.{j}.DestIP - Specifies the destination IP address or network used as a matching criterion. W
  13. Device.Firewall.Zone.{i}.Rule.{j}.DestMask - Specifies the destination IP network mask in CIDR notation. W
  14. Device.Firewall.Zone.{i}.Rule.{j}.DestIPExclude - Specifies whether traffic matching the destination IP criterion should be excluded from the rule. W
  15. Device.Firewall.Zone.{i}.Rule.{j}.SourceIP - Specifies the source IP address or network used as a matching criterion. W
  16. Device.Firewall.Zone.{i}.Rule.{j}.SourceMask - Specifies the source IP network mask in CIDR notation. W
  17. Device.Firewall.Zone.{i}.Rule.{j}.SourceIPExclude - Specifies whether traffic matching the source IP criterion should be excluded from the rule. W
  18. Device.Firewall.Zone.{i}.Rule.{j}.Protocol - Specifies the network protocol used as a matching criterion. W
  19. Device.Firewall.Zone.{i}.Rule.{j}.DestPort - Specifies the destination port used as a matching criterion. W
  20. Device.Firewall.Zone.{i}.Rule.{j}.DestPortRangeMax - Specifies the maximum value of the destination port range when a destination port range is configured. W
  21. Device.Firewall.Zone.{i}.Rule.{j}.SourcePort - Specifies the source port used as a matching criterion. W
  22. Device.Firewall.Zone.{i}.Rule.{j}.SourcePortRangeMax - Specifies the maximum value of the source port range when a source port range is configured. W
  23. Device.Firewall.Zone.{i}.Rule.{j}.SourcePortExclude - Specifies whether traffic matching the source port criterion should be excluded from the rule. W
  24. Device.Firewall.Zone.{i}.Rule.{j}.DSCP - Specifies the DSCP value used as a packet-matching criterion. W
  25. Device.Firewall.Zone.{i}.Rule.{j}.ConnectionState - Specifies the connection states to which the rule applies. W
  26. Device.Firewall.Zone.{i}.Rule.{j}.SourceMAC - Specifies the source MAC address used as a matching criterion. W
  27. Device.Firewall.Zone.{i}.Rule.{j}.SourceMACExclude - Specifies whether traffic matching the source MAC address should be excluded from the rule. W
  28. Device.Firewall.Zone.{i}.Rule.{j}.ICMPType - Specifies the ICMP message type used as a matching criterion. W
  29. Device.Firewall.DMZ - Custom object representing the DMZ configuration. W
  30. Device.Firewall.DMZ.{i}.LeaseDuration - Specifies the duration of the DMZ lease. W

Device IP TraceRoute information:

  1. Device.IP.Diagnostics.TraceRoute.DiagnosticsState- Indicates the availability of diagnostics data. W
  2. Device.IP.Diagnostics.TraceRoute.Interface - Specifies the interface to be used for the trace route test. W
  3. Device.IP.Diagnostics.TraceRoute.ProtocolVersion - Indicates the IP protocol to be used. W
  4. Device.IP.Diagnostics.TraceRoute.Host - Host name or address of the host to find a route to. W
  5. Device.IP.Diagnostics.TraceRoute.NumberOfTries - Number of tries per hop. W
  6. Device.IP.Diagnostics.TraceRoute.Timeout - Timeout in seconds for each hop of the trace route test. W
  7. Device.IP.Diagnostics.TraceRoute.DSCP - DiffServ codepoint to be used for the test packets. W
  8. Device.IP.Diagnostics.TraceRoute.MaxHopCount - The maximum number of hop used in outgoing probe packets (max TTL). W
  9. Device.IP.Diagnostics.TraceRoute.IPAddressUsed - Indicates which IP address was used for TraceRoute. R
  10. Device.IP.Diagnostics.TraceRoute.ResponseTime - Result parameter indicating the response time in seconds the most recent trace route test. R

Device VLAN information:

  1. Device.VLAN.PortBasedNumberOfEntries - Number of Port Based VLAN entries. R
  2. Device.VLAN.InterfaceBasedNumberOfEntries - Number of Interface Based VLAN entries. R
  3. Device.VLAN.PortBased.{i}.VID - VLAN Identification number. W
  4. Device.VLAN.PortBased.{i}.LAN1 - State of LAN port 1: off, untagged, or tagged. W
  5. Device.VLAN.PortBased.{i}.LAN2 - State of LAN port 2: off, untagged, or tagged. W
  6. Device.VLAN.PortBased.{i}.LAN3 - State of LAN port 3: off, untagged, or tagged. W
  7. Device.VLAN.PortBased.{i}.LAN4 - State of LAN port 4: off, untagged, or tagged. W
  8. Device.VLAN.PortBased.{i}.WAN - State of WAN port: off, untagged, or tagged. W
  9. Device.VLAN.InterfaceBased.{i}.Name - Name of the VLAN device. R
  10. Device.VLAN.InterfaceBased.{i}.VID - VLAN tag for this device. W
  11. Device.VLAN.InterfaceBased.{i}.Interface - Ethernet interface this VLAN device is attached to (e.g. eth0). W
  12. Device.VLAN.InterfaceBased.{i}.Type - VLAN type: 802.1Q or 802.1AD. W
  13. Device.VLAN.InterfaceBased.{i}.DeviceNumberOfEntries - Number of Q-in-Q devices under this VLAN. R
  14. Device.VLAN.InterfaceBased.{i}.Device.{j}.Name - Name of the Q-in-Q device. R
  15. Device.VLAN.InterfaceBased.{i}.Device.{j}.VID - 802.1Q tag for the Q-in-Q device. W
  16. Device.VLAN.InterfaceBased.{i}.Device.{j}.Interface - Parent interface the Q-in-Q device is tagged on top of. W


Device IP Interface information:

  1. Device.IP.Interface.{i}. - Custom object representing an IP interface according to the TR-181 data model. W
  2. Device.IP.Interface.{i}.Enable - Enables or disables the IP interface. W
  3. Device.IP.Interface.{i}.Status - Indicates the current operational status of the IP interface. W
  4. Device.IP.Interface.{i}.Name - Specifies the name assigned to the IP interface. W
  5. Device.IP.Interface.{i}.LastChange - Indicates the time elapsed since the interface entered its current operational state. W
  6. Device.IP.Interface.{i}.LowerLayers - Specifies the lower-layer interface or interfaces associated with the IP interface. W
  7. Device.IP.Interface.{i}.Reset - Resets the IP connection by bringing the interface down and then back up. W
  8. Device.IP.Interface.{i}.ULAEnable - Enables or disables the use of IPv6 Unique Local Addresses (ULAs) on the interface. W
  9. Device.IP.Interface.{i}.MaxMTUSize - Specifies the maximum transmission unit (MTU) size supported by the IP interface. W
  10. Device.IP.Interface.{i}.Type - Specifies the type of IP interface, such as a normal or loopback interface. W
  11. Device.IP.Interface.{i}.Loopback - Configures the IP interface as a loopback interface. W
  12. Device.IP.Interface.{i}.IPv4Address.{i}. - Custom object representing an IPv4 address assigned to the IP interface. W
  13. Device.IP.Interface.{i}.IPv4Address.{i}.AddressingType - Specifies how the IPv4 address was assigned, such as DHCP, Static, or 3GPP-NAS. W
  14. Device.IP.Interface.{i}.IPv4Address.{i}.IPAddress - Specifies the IPv4 address assigned to the interface. W
  15. Device.IP.Interface.{i}.IPv4Address.{i}.SubnetMask - Specifies the subnet mask associated with the IPv4 address. W
  16. Device.IP.Interface.{i}.Stats.BytesSent - Specifies the total number of bytes transmitted through the interface. W
  17. Device.IP.Interface.{i}.Stats.BytesReceived - Specifies the total number of bytes received through the interface. W
  18. Device.IP.Interface.{i}.Stats.PacketsSent - Specifies the total number of packets transmitted through the interface. W
  19. Device.IP.Interface.{i}.Stats.PacketsReceived - Specifies the total number of packets received through the interface. W
  20. Device.IP.Interface.{i}.Stats.ErrorsSent - Specifies the number of outbound packets that could not be transmitted due to errors. W
  21. Device.IP.Interface.{i}.Stats.ErrorsReceived - Specifies the number of inbound packets that contained errors. W
  22. Device.IP.Interface.{i}.Stats.MulticastPacketsReceived - Specifies the number of multicast packets received through the interface. W
  23. Device.IP.Interface.{i}.IPv6Address.{i}. - Custom object representing an IPv6 address assigned to the IP interface. W
  24. Device.IP.Interface.{i}.IPv6Address.{i}.IPAddressStatus - Indicates the current usability status of the IPv6 address. R
  25. Device.IP.Interface.{i}.IPv6Address.{i}.IPAddress - Specifies the IPv6 address assigned to the interface. W
  26. Device.IP.Interface.{i}.IPv6Address.{i}.PreferredLifetime - Specifies the time until the IPv6 address becomes deprecated. W
  27. Device.IP.Interface.{i}.IPv6Address.{i}.ValidLifetime - Specifies the time until the IPv6 address becomes invalid. W
Retrieved from "https://wiki.teltonika-networks.com/index.php?title=RUTM08_TR-069&oldid=181804"