Table of Contents
-
The top-level object for a Device.

6.39
RootDataModelVersion
Device.RootDataModelVersion
-
Root data model version, e.g. ''2.4''. For a vendor-defined root data model, this is the standard Broadband Forum model on which the vendor-defined model is based.

type: string(32)
6.39
InterfaceStackNumberOfEntries
Device.InterfaceStackNumberOfEntries
-
The number of entries in the InterfaceStack table.

type: uint32
6.39
-
This object contains general device information.

6.39
Manufacturer
Device.DeviceInfo.Manufacturer
-
The manufacturer of the CPE (human readable string).

type: string(64)
6.39
ManufacturerOUI
Device.DeviceInfo.ManufacturerOUI
-
Organizationally unique identifier of the device manufacturer. Represented as a six hexadecimal-digit value using all upper-case letters and including any leading zeros.

The value MUST be a valid OUI as defined in [OUI].

This value MUST remain fixed over the lifetime of the device, including across firmware updates. Any change would indicate that it's a new device and would therefore require a BOOTSTRAP Inform.

type: string(6:6)
6.39
ModelName
Device.DeviceInfo.ModelName
-
Model name of the CPE (human readable string).

type: string(64) , flags: deny-active-notif
6.39
Description
Device.DeviceInfo.Description
-
A full description of the CPE device (human readable string).

type: string(256) , flags: deny-active-notif
6.39
ProductClass
Device.DeviceInfo.ProductClass
-
Identifier of the class of product for which the serial number applies. That is, for a given manufacturer, this parameter is used to identify the product or class of product over which the SerialNumber parameter is unique.

This value MUST remain fixed over the lifetime of the device, including across firmware updates. Any change would indicate that it's a new device and would therefore require a BOOTSTRAP Inform.

type: string(64)
6.39
SerialNumber
Device.DeviceInfo.SerialNumber
-
Identifier of the particular device that is unique for the indicated class of product and manufacturer.

This value MUST remain fixed over the lifetime of the device, including across firmware updates. Any change would indicate that it's a new device and would therefore require a BOOTSTRAP Inform.

type: string(64)
6.39
HardwareVersion
Device.DeviceInfo.HardwareVersion
-
A string identifying the particular CPE model and version.

type: string(64)
6.39
SoftwareVersion
Device.DeviceInfo.SoftwareVersion
-
A string identifying the software version currently installed in the CPE (i.e. version of the overall CPE firmware).

To allow version comparisons, this element SHOULD be in the form of dot-delimited integers, where each successive integer represents a more minor category of variation. For example, ''3.0.21'' where the components mean: ''Major.Minor.Build''.

type: string(64)
6.39
ProvisioningCode
Device.DeviceInfo.ProvisioningCode
W
Identifier of the primary service provider and other provisioning information, which MAY be used by the ACS to determine service provider-specific customization and provisioning parameters.

type: string(64)
6.39
UpTime
Device.DeviceInfo.UpTime
-
Time in seconds since the CPE was last restarted.

type: uint32 , flags: deny-active-notif
6.39
VendorConfigFileNumberOfEntries
Device.DeviceInfo.VendorConfigFileNumberOfEntries
-
The number of entries in the VendorConfigFile table.

type: uint32
6.39
X_MIKROTIK_SystemIdentity
Device.DeviceInfo.X_MIKROTIK_SystemIdentity
W
Value of system identity

type: string
ROS: /system identity =name
6.39
X_MIKROTIK_ArchName
Device.DeviceInfo.X_MIKROTIK_ArchName
-
Value of ROS architecture name

type: string
ROS: /system resource =architecture-name
6.39
-
For now this table contains "dummy" record of full ROS configuration export. This could change in future.

Name
Device.DeviceInfo.VendorConfigFile.{i}.Name
-
"Dummy" name of configuration file.

type: string(64)
6.39
Description
Device.DeviceInfo.VendorConfigFile.{i}.Description
-
A description of the vendor configuration file (human-readable string).

type: string(256)
6.39
UseForBackupRestore
Device.DeviceInfo.VendorConfigFile.{i}.UseForBackupRestore
-
When true, this parameter indicates that this VendorConfigFile. instance is to be used for backup and restoration purposes.

Note: The backup and restore operations may require the use of multiple VendorConfigFile. instances. In this scenario the mechanism for detemining the order and combination of VendorConfigFile. instances used for backup and restoration purposes is implementation specific.

type: bool
6.39
-
Status of the device's volatile physical memory.

6.39
Total
Device.DeviceInfo.MemoryStatus.Total
-
The total physical RAM, in kilobytes, installed on the device.

type: uint32
6.39
Free
Device.DeviceInfo.MemoryStatus.Free
-
The free physical RAM, in kilobytes, currently available on the device.

type: uint32 , flags: deny-active-notif
6.39
-
Status of the processes on the device.

6.39
CPUUsage
Device.DeviceInfo.ProcessStatus.CPUUsage
-
The total amount of the CPU, in percent, rounded up to the nearest whole percent. In the case that multiple CPU are present, this value represents the average of all CPU.

type: uint32[:100] , flags: deny-active-notif
6.39
-
This object contains parameters relating to the CPE's association with an ACS.

6.39
URL
Device.ManagementServer.URL
W
URL, as defined in [RFC3986], for the CPE to connect to the ACS using the CPE WAN Management Protocol.

This parameter MUST be in the form of a valid HTTP or HTTPS URL.

The ''host'' portion of this URL is used by the CPE for validating the ACS certificate when using SSL or TLS.

Note that on a factory reset of the CPE, the value of this parameter might be reset to its factory value. If an ACS modifies the value of this parameter, it SHOULD be prepared to accommodate the situation that the original value is restored as the result of a factory reset.

type: string(256)
ROS: /tr069-client =acs-url
6.39
Username
Device.ManagementServer.Username
W
Username used to authenticate the CPE when making a connection to the ACS using the CPE WAN Management Protocol.

This username is used only for HTTP-based authentication of the CPE.

Note that on a factory reset of the CPE, the value of this parameter might be reset to its factory value. If an ACS modifies the value of this parameter, it SHOULD be prepared to accommodate the situation that the original value is restored as the result of a factory reset.

type: string(256)
ROS: /tr069-client =username
6.39
Password
Device.ManagementServer.Password
W
Password used to authenticate the CPE when making a connection to the ACS using the CPE WAN Management Protocol.

This password is used only for HTTP-based authentication of the CPE.

Note that on a factory reset of the CPE, the value of this parameter might be reset to its factory value. If an ACS modifies the value of this parameter, it SHOULD be prepared to accommodate the situation that the original value is restored as the result of a factory reset.

type: string(256) , flags: hidden
ROS: /tr069-client =password
6.39
PeriodicInformEnable
Device.ManagementServer.PeriodicInformEnable
W
Whether or not the CPE MUST periodically send CPE information to the ACS using the Inform method call.

type: bool
ROS: /tr069-client =periodic-inform-enabled
6.39
PeriodicInformInterval
Device.ManagementServer.PeriodicInformInterval
W
The duration in seconds of the interval for which the CPE MUST attempt to connect with the ACS and call the Inform method if PeriodicInformEnable is true.

type: uint32[1:]
ROS: /tr069-client =periodic-inform-interval
6.39
ParameterKey
Device.ManagementServer.ParameterKey
-
ParameterKey provides the ACS a reliable and extensible means to track changes made by the ACS. The value of ParameterKey MUST be equal to the value of the ParameterKey argument from the most recent successful SetParameterValues, AddObject, or DeleteObject method call from the ACS.

The CPE MUST set ParameterKey to the value specified in the corresponding method arguments if and only if the method completes successfully and no fault response is generated. If a method call does not complete successfully (implying that the changes requested in the method did not take effect), the value of ParameterKey MUST NOT be modified.

The CPE MUST only modify the value of ParameterKey as a result of SetParameterValues, AddObject, DeleteObject, or due to a factory reset. On factory reset, the value of ParameterKey MUST be set to empty string.

type: string(32) , flags: deny-active-notif
6.39
ConnectionRequestURL
Device.ManagementServer.ConnectionRequestURL
-
HTTP URL, as defined in [RFC3986], for an ACS to make a Connection Request notification to the CPE.

In the form:

: http://host:port/path

The ''host'' portion of the URL MAY be the IP address for the management interface of the CPE in lieu of a host name.

Note: If the ''host'' portion of the URL is a literal IPv6 address then it MUST be enclosed in square brackets (see [RFC3986]).

type: string(256)
6.39
ConnectionRequestUsername
Device.ManagementServer.ConnectionRequestUsername
W
Username used to authenticate an ACS making a Connection Request to the CPE.

type: string(256)
ROS: /tr069-client =connection-request-username
6.39
ConnectionRequestPassword
Device.ManagementServer.ConnectionRequestPassword
W
Password used to authenticate an ACS making a Connection Request to the CPE.

type: string(256) , flags: hidden
ROS: /tr069-client =connection-request-password
6.39
AliasBasedAddressing
Device.ManagementServer.AliasBasedAddressing
-
Indicates whether or not the Alias-Based Addressing Mechanism is supported.

A true value indicates that the CPE supports the Alias-Based Addressing Mechanism, as defined in [TR-069a4] and described in [TR-069a4].

type: bool
6.39
-
This table contains information about the relationships between the multiple layers of interface objects ([TR-181i2]). In particular, it contains information on which interfaces run ''on top of'' which other interfaces.

This table is auto-generated by the CPE based on the ''LowerLayers'' parameters on individual interface objects.

Each table row represents a "link" between two interface objects, a higher-layer interface object (referenced by HigherLayer) and a lower-layer interface object (referenced by LowerLayer). Consequently, if a referenced interface object is deleted, the CPE MUST delete the corresponding {i}. row(s) that had referenced it.

HigherLayer
Device.InterfaceStack.{i}.HigherLayer
-
A reference to the interface object corresponding to the higher layer of the relationship, i.e. the interface which runs on ''top'' of the interface identified by the corresponding instance of LowerLayer.

When the referenced higher layer interface is deleted, the CPE MUST delete the table row.

type: strongRef(256)
6.39
LowerLayer
Device.InterfaceStack.{i}.LowerLayer
-
A reference to the interface object corresponding to the lower layer of the relationship, i.e. the interface which runs ''below'' the interface identified by the corresponding instance of HigherLayer.

When the referenced lower layer interface is deleted, the CPE MUST delete the table row.

type: strongRef(256)
6.39
-
This object models cellular interfaces and access points.

6.39
InterfaceNumberOfEntries
Device.Cellular.InterfaceNumberOfEntries
-
The number of entries in the Interface table.

type: uint32
6.39
AccessPointNumberOfEntries
Device.Cellular.AccessPointNumberOfEntries
-
The number of entries in the AccessPoint table.

type: uint32
6.39
-
Cellular interface table (a stackable interface object as described in [TR-181i2]). Each instance of this object models a cellular modem with a single radio and a single USIM.


ROS: /interface lte
Enable
Device.Cellular.Interface.{i}.Enable
W
Enables or disables the interface.

This parameter is based on ''ifAdminStatus'' from [RFC2863].

type: bool
ROS: /interface lte =disabled
6.39
Status
Device.Cellular.Interface.{i}.Status
-
The current operational state of the interface (see [TR-181i2]).

When Enable is false then Status SHOULD normally be Down (or NotPresent or Error if there is a fault condition on the interface).

When Enable is changed to true then Status

* SHOULD change to Up if and only if the interface is able to transmit and receive network traffic.

* SHOULD change to Dormant if and only if the interface is operable but is waiting for external actions before it can transmit and receive network traffic (and subsequently change to Up if still operable when the expected actions have completed)

* SHOULD remain in the Error state if there is an error or other fault condition detected on the interface

* SHOULD remain in the NotPresent state if the interface has missing (typically hardware) components; it SHOULD change to Unknown if the state of the interface can not be determined for some reason.

Because the interface includes layer 1 the LowerLayerDown value SHOULD never be used.

This parameter is based on ''ifOperStatus'' from [RFC2863].

  • Up ( Corresponds to {{enum|GPRS|CurrentAccessTechnology}}, {{enum|UMTS|CurrentAccessTechnology}}, {{enum|LTE|CurrentAccessTechnology}} etc ''ATTACHED'' status )
  • Down
  • Unknown
  • Dormant
  • NotPresent ( Corresponds to {{enum|GPRS|CurrentAccessTechnology}}, {{enum|UMTS|CurrentAccessTechnology}}, {{enum|LTE|CurrentAccessTechnology}} etc ''DETACHED'' status )
  • LowerLayerDown
  • Error

type: enum , flags: deny-active-notif
6.39
LowerLayers
Device.Cellular.Interface.{i}.LowerLayers
-
See [TR-181i2].

Note: Since Interface. is a layer 1 interface, it is expected that LowerLayers will not be used.

type: list<strongRef>(1024)
6.39
IMEI
Device.Cellular.Interface.{i}.IMEI
-
International Mobile Station Equipment Identity number, represented as a 15 digit string (digits 0-9).

type: string(15:15)
6.39
RSSI
Device.Cellular.Interface.{i}.RSSI
-
The received signal strength in dBm. Value not available for LTE.

type: int32 , flags: deny-active-notif
6.39
X_MIKROTIK_SINR
Device.Cellular.Interface.{i}.X_MIKROTIK_SINR
-
SINR value in dB.

type: int32 , flags: deny-active-notif
6.39
X_MIKROTIK_RSRP
Device.Cellular.Interface.{i}.X_MIKROTIK_RSRP
-
RSRP value in dBm.

type: int32 , flags: deny-active-notif
6.39
X_MIKROTIK_RSRQ
Device.Cellular.Interface.{i}.X_MIKROTIK_RSRQ
-
RSRQ value in dB.

type: int32 , flags: deny-active-notif
6.39
X_MIKROTIK_CellId
Device.Cellular.Interface.{i}.X_MIKROTIK_CellId
-
Cell ID value

type: uint32
6.39
X_MIKROTIK_BandInfo
Device.Cellular.Interface.{i}.X_MIKROTIK_BandInfo
-
Band info - earfcn

type: string
6.39
X_MIKROTIK_AccessPoints
Device.Cellular.Interface.{i}.X_MIKROTIK_AccessPoints
W
ROS uses this Parameter in place of standard "Device.Cellular.AccessPoint.{i}.Interface" for more flexibility.

Links with list of AccessPoint profiles for this Interface.

type: list<strongRef>(1024)
ROS: /interface lte =apn-profiles
6.41
-
Throughput statistics for this interface.

The CPE MUST reset the interface's Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface's Device.Cellular.Interface.{i}.Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface's Device.Cellular.Interface.{i}.Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [TR-181i2].

6.39
BytesSent
Device.Cellular.Interface.{i}.Stats.BytesSent
-
The total number of bytes transmitted out of the interface, including framing characters.

type: StatsCounter64 , flags: deny-active-notif
6.39
BytesReceived
Device.Cellular.Interface.{i}.Stats.BytesReceived
-
The total number of bytes received on the interface, including framing characters.

type: StatsCounter64 , flags: deny-active-notif
6.39
PacketsSent
Device.Cellular.Interface.{i}.Stats.PacketsSent
-
The total number of packets transmitted out of the interface.

type: StatsCounter64 , flags: deny-active-notif
6.39
PacketsReceived
Device.Cellular.Interface.{i}.Stats.PacketsReceived
-
The total number of packets received on the interface.

type: StatsCounter64 , flags: deny-active-notif
6.39
ErrorsSent
Device.Cellular.Interface.{i}.Stats.ErrorsSent
-
The total number of outbound packets that could not be transmitted because of errors.

type: StatsCounter64 , flags: deny-active-notif
6.39
ErrorsReceived
Device.Cellular.Interface.{i}.Stats.ErrorsReceived
-
The total number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol.

type: StatsCounter64 , flags: deny-active-notif
6.39
DiscardPacketsSent
Device.Cellular.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.

type: StatsCounter64 , flags: deny-active-notif
6.39
DiscardPacketsReceived
Device.Cellular.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.

type: StatsCounter64 , flags: deny-active-notif
6.39
W
Cellular Access Point table. Each entry is identified by an APN (Access Point Name) that identifies a gateway between the mobile network and another computer network.


ROS: /interface lte apn
APN
Device.Cellular.AccessPoint.{i}.APN
W
Access Point Name.

type: string(64)
ROS: /interface lte apn =apn
6.39
Username
Device.Cellular.AccessPoint.{i}.Username
W
Username used to authenticate the CPE when making a connection to the Access Point.

type: string(256)
ROS: /interface lte apn =user
6.39
Password
Device.Cellular.AccessPoint.{i}.Password
W
Password used to authenticate the CPE when making a connection to the Access Point.

type: string(256) , flags: hidden
ROS: /interface lte apn =password
6.39
-
Ethernet object. This object models several Ethernet interface objects, each representing a different stack layer, including: Interface, Link, and VLANTermination. Interface is media-specific and models a port, the PHY layer, and the MAC layer. Link is media-independent and models the Logical Link Control (LLC) layer. An "outer" VLANTermination, when present, is expected to be stacked on top of Link objects to receive and send frames with a configured VLANID.

NOTE that VLANTermination object is not supported yet.
6.39
InterfaceNumberOfEntries
Device.Ethernet.InterfaceNumberOfEntries
-
The number of entries in the Interface table.

type: uint32
6.39
LinkNumberOfEntries
Device.Ethernet.LinkNumberOfEntries
-
The number of entries in the Link table.

type: uint32
6.39
-
Ethernet interface table (a stackable interface object as described in [TR-181i2]). This table models physical Ethernet ports, but in terms of the interface stack it also models the PHY and MAC level Ethernet interface.


ROS: /interface ethernet
Enable
Device.Ethernet.Interface.{i}.Enable
W
Enables or disables the interface.

This parameter is based on ''ifAdminStatus'' from [RFC2863].

type: bool
ROS: /interface ethernet =disabled
6.39
Status
Device.Ethernet.Interface.{i}.Status
-
The current operational state of the interface (see [TR-181i2]).

When Enable is false then Status SHOULD normally be Down (or NotPresent or Error if there is a fault condition on the interface).

When Enable is changed to true then Status SHOULD change to Up if and only if the interface is able to transmit and receive network traffic; it SHOULD change to Dormant if and only if the interface is operable but is waiting for external actions before it can transmit and receive network traffic (and subsequently change to Up if still operable when the expected actions have completed); it SHOULD change to LowerLayerDown if and only if the interface is prevented from entering the Up state because one or more of the interfaces beneath it is down; it SHOULD remain in the Error state if there is an error or other fault condition detected on the interface; it SHOULD remain in the NotPresent state if the interface has missing (typically hardware) components; it SHOULD change to Unknown if the state of the interface can not be determined for some reason.

This parameter is based on ''ifOperStatus'' from [RFC2863].

  • Up
  • Down
  • Unknown
  • Dormant
  • NotPresent
  • LowerLayerDown
  • Error

type: enum
6.39
LowerLayers
Device.Ethernet.Interface.{i}.LowerLayers
-
See [TR-181i2].

Note: Since Interface. is a layer 1 interface, it is expected that LowerLayers will not be used.

type: list<strongRef>(1024)
6.39
MACAddress
Device.Ethernet.Interface.{i}.MACAddress
-
The MAC Address of the interface.

Note: This is not necessarily the same as the Ethernet header source or destination MAC address, which is associated with the IP interface and is modeled via the Device.Ethernet.Link.{i}.MACAddress parameter.

type: MACAddress
ROS: /interface ethernet =orig-mac-address
6.39
-
Throughput statistics for this interface.

The CPE MUST reset the interface's Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface's Device.Ethernet.Interface.{i}.Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface's Device.Ethernet.Interface.{i}.Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [TR-181i2].

6.39
BytesSent
Device.Ethernet.Interface.{i}.Stats.BytesSent
-
The total number of bytes transmitted out of the interface, including framing characters.

type: uint64 , flags: deny-active-notif
6.39
BytesReceived
Device.Ethernet.Interface.{i}.Stats.BytesReceived
-
The total number of bytes received on the interface, including framing characters.

type: uint64 , flags: deny-active-notif
6.39
PacketsSent
Device.Ethernet.Interface.{i}.Stats.PacketsSent
-
The total number of packets transmitted out of the interface.

type: uint64 , flags: deny-active-notif
6.39
PacketsReceived
Device.Ethernet.Interface.{i}.Stats.PacketsReceived
-
The total number of packets received on the interface.

type: uint64 , flags: deny-active-notif
6.39
ErrorsSent
Device.Ethernet.Interface.{i}.Stats.ErrorsSent
-
The total number of outbound packets that could not be transmitted because of errors.

type: uint32 , flags: deny-active-notif
6.39
ErrorsReceived
Device.Ethernet.Interface.{i}.Stats.ErrorsReceived
-
The total number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol.

type: uint32 , flags: deny-active-notif
6.39
DiscardPacketsSent
Device.Ethernet.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.

type: uint32 , flags: deny-active-notif
6.39
DiscardPacketsReceived
Device.Ethernet.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.

type: uint32 , flags: deny-active-notif
6.39
W
Ethernet link layer table (a stackable interface object as described in [TR-181i2]). Table entries model the Logical Link Control (LLC) layer. It is expected that an ''Ethernet Link'' interface can be stacked above any lower-layer interface object capable of carrying Ethernet frames.

Enable
Device.Ethernet.Link.{i}.Enable
W
Enables or disables the link.

This parameter is based on ''ifAdminStatus'' from [RFC2863].

type: bool , default: "false"
6.39
Status
Device.Ethernet.Link.{i}.Status
-
The current operational state of the link (see [TR-181i2]).

When Enable is false then Status SHOULD normally be Down (or NotPresent or Error if there is a fault condition on the interface).

When Enable is changed to true then Status SHOULD change to Up if and only if the interface is able to transmit and receive network traffic; it SHOULD change to Dormant if and only if the interface is operable but is waiting for external actions before it can transmit and receive network traffic (and subsequently change to Up if still operable when the expected actions have completed); it SHOULD change to LowerLayerDown if and only if the interface is prevented from entering the Up state because one or more of the interfaces beneath it is down; it SHOULD remain in the Error state if there is an error or other fault condition detected on the interface; it SHOULD remain in the NotPresent state if the interface has missing (typically hardware) components; it SHOULD change to Unknown if the state of the interface can not be determined for some reason.

This parameter is based on ''ifOperStatus'' from [RFC2863].

  • Up
  • Down
  • Unknown
  • Dormant
  • NotPresent
  • LowerLayerDown
  • Error

type: enum , default: "Down"
6.39
LowerLayers
Device.Ethernet.Link.{i}.LowerLayers
W
See [TR-181i2].

type: list<strongRef>(1024) , default: ""
6.39
-
The WiFi object is based on the WiFi Alliance 802.11 specifications ([802.11-2007]). It defines interface objects (Radio and SSID), and application objects (AccessPoint and EndPoint).

NOTE that EndPoint object is not supported yet.
6.39
RadioNumberOfEntries
Device.WiFi.RadioNumberOfEntries
-
The number of entries in the Radio table.

type: uint32
6.39
SSIDNumberOfEntries
Device.WiFi.SSIDNumberOfEntries
-
The number of entries in the SSID table.

type: uint32
6.39
AccessPointNumberOfEntries
Device.WiFi.AccessPointNumberOfEntries
-
The number of entries in the AccessPoint table.

type: uint32
6.39
-
This object models an 802.11 wireless radio on a device (a stackable interface object as described in [TR-181i2]).

If the device can establish more than one connection simultaneously (e.g. a dual radio device), a separate {i}. instance MUST be used for each physical radio of the device. See [TR-181i2] for additional information.

Note: A dual-band single-radio device (e.g. an 802.11a/b/g radio) can be configured to operate at 2.4 or 5 GHz frequency bands, but only a single frequency band is used to transmit/receive at a given time. Therefore, a single {i}. instance is used even for a dual-band radio.


ROS: /interface wireless =interface-type!=virtual
Enable
Device.WiFi.Radio.{i}.Enable
W
Enables or disables the radio.

This parameter is based on ''ifAdminStatus'' from [RFC2863].

type: bool
ROS: /interface wireless =disabled
6.39
Status
Device.WiFi.Radio.{i}.Status
-
The current operational state of the radio (see [TR-181i2]).

When Enable is false then Status SHOULD normally be Down (or NotPresent or Error if there is a fault condition on the interface).

When Enable is changed to true then Status SHOULD change to Up if and only if the interface is able to transmit and receive network traffic; it SHOULD change to Dormant if and only if the interface is operable but is waiting for external actions before it can transmit and receive network traffic (and subsequently change to Up if still operable when the expected actions have completed); it SHOULD change to LowerLayerDown if and only if the interface is prevented from entering the Up state because one or more of the interfaces beneath it is down; it SHOULD remain in the Error state if there is an error or other fault condition detected on the interface; it SHOULD remain in the NotPresent state if the interface has missing (typically hardware) components; it SHOULD change to Unknown if the state of the interface can not be determined for some reason.

This parameter is based on ''ifOperStatus'' from [RFC2863].

  • Up
  • Down
  • Unknown
  • Dormant
  • NotPresent
  • LowerLayerDown
  • Error

type: enum
6.39
LowerLayers
Device.WiFi.Radio.{i}.LowerLayers
-
See [TR-181i2].

Note: Since Radio. is a layer 1 interface, it is expected that LowerLayers will not be used.

type: list<strongRef>(1024)
6.39
SupportedFrequencyBands
Device.WiFi.Radio.{i}.SupportedFrequencyBands
-
List items indicate the frequency bands at which the radio can operate.

  • 2.4GHz
  • 5GHz

type: list<enum>
6.39
OperatingFrequencyBand
Device.WiFi.Radio.{i}.OperatingFrequencyBand
W
Indicates the frequency band at which the radio is operating.

If the radio supports multiple bands, and OperatingFrequencyBand is changed, then all parameters whose value is not valid for the new frequency band (e.g. Channel) MUST be set to a valid value (according to some CPE vendor-specific behavior).

type: string
ROS: /interface wireless =band
6.39
SupportedStandards
Device.WiFi.Radio.{i}.SupportedStandards
-
List items indicate which IEEE 802.11 standards this Radio. instance can support simultaneously, in the frequency band specified by OperatingFrequencyBand.

Each value indicates support for the indicated standard.

If OperatingFrequencyBand is set to 2.4GHz, only values b, g, n are allowed.

If OperatingFrequencyBand is set to 5GHz, only values a, n, ac are allowed.

  • a ( {{bibref|802.11a-1999}} )
  • b ( {{bibref|802.11b-1999}} )
  • g ( {{bibref|802.11g-2003}} )
  • n ( {{bibref|802.11n-2009}} )
  • ac ( {{bibref|802.11ac-2013}} )

type: list<enum>
6.39
OperatingStandards
Device.WiFi.Radio.{i}.OperatingStandards
W
List items indicate which IEEE 802.11 standard this Radio. instance is configured for.

Each value indicates support for the indicated standard.

If OperatingFrequencyBand is set to 2.4GHz, only values b, g, n are allowed.

If OperatingFrequencyBand is set to 5GHz, only values a, n, ac are allowed.

For example, a value of "g,b" (or "b,g" - order is not important) means that the 802.11g standard [802.11g-2003] is used with a backwards-compatible mode for 802.11b [802.11b-1999]. A value of "g" means that only the 802.11g standard can be used.

type: list<string>
ROS: /interface wireless =band
6.39
PossibleChannels
Device.WiFi.Radio.{i}.PossibleChannels
-
List items represent possible radio channels for the wireless standard (a, b, g, n) and the regulatory domain.

Ranges in the form "n-m" are permitted.

For example, for 802.11b and North America, would be "1-11".

type: list<string>(1024)
6.39
Channel
Device.WiFi.Radio.{i}.Channel
W
The current radio channel used by the connection. To request automatic channel selection, set AutoChannelEnable to true.

Whenever AutoChannelEnable is true, the value of the Channel parameter MUST be the channel selected by the automatic channel selection procedure.

Note: Valid Channel values depend on the OperatingFrequencyBand and RegulatoryDomain values specified.

type: uint32[1:255]
ROS: /interface wireless =frequency
6.39
AutoChannelSupported
Device.WiFi.Radio.{i}.AutoChannelSupported
-
Indicates whether automatic channel selection is supported by this radio. If false, then AutoChannelEnable MUST be false.

type: bool
6.39
AutoChannelEnable
Device.WiFi.Radio.{i}.AutoChannelEnable
W
Enable or disable automatic channel selection.

Set to false to disable the automatic channel selection procedure, in which case the currently selected channel remains selected.

Set to true to enable the automatic channel selection procedure. This procedure MUST automatically select the channel, and MAY also change it subsequently.

AutoChannelEnable MUST automatically change to false whenever the channel is manually selected, i.e. whenever the Channel parameter is written.

Whenever AutoChannelEnable is true, the value of the Channel parameter MUST be the channel selected by the automatic channel selection procedure.

type: bool
ROS: /interface wireless =frequency
6.39
-
This object defines access to other WiFi SSIDs that this device is able to receive.

6.39
DiagnosticsState
Device.WiFi.NeighboringWiFiDiagnostic.DiagnosticsState
W


  • None
  • Requested
  • Canceled
  • Complete
  • Error
  • Completed

type: DiagnosticsState
6.39
ResultNumberOfEntries
Device.WiFi.NeighboringWiFiDiagnostic.ResultNumberOfEntries
-
The number of entries in the Result table.

type: uint32
6.39
-
Neighboring SSID table. This table models the other WiFi SSIDs that this device is able to receive.

Radio
Device.WiFi.NeighboringWiFiDiagnostic.Result.{i}.Radio
-
The Radio that detected the neighboring WiFi SSID.

type: strongRef
6.39
SSID
Device.WiFi.NeighboringWiFiDiagnostic.Result.{i}.SSID
-
The current service set identifier in use by the neighboring WiFi SSID. The value MAY be empty for hidden SSIDs.

type: string(32)
6.39
BSSID
Device.WiFi.NeighboringWiFiDiagnostic.Result.{i}.BSSID
-
The BSSID used for the neighboring WiFi SSID.

type: MACAddress
6.39
Channel
Device.WiFi.NeighboringWiFiDiagnostic.Result.{i}.Channel
-
The current radio channel used by the neighboring WiFi radio.

type: uint32[1:255]
6.39
SignalStrength
Device.WiFi.NeighboringWiFiDiagnostic.Result.{i}.SignalStrength
-
An indicator of radio signal strength (RSSI) of the neighboring WiFi radio measured in dBm, as an average of the last 100 packets received.

type: int32[-200:]
6.39
OperatingFrequencyBand
Device.WiFi.NeighboringWiFiDiagnostic.Result.{i}.OperatingFrequencyBand
-
Indicates the frequency band at which the radio this SSID instance is operating.

  • 2.4GHz
  • 5GHz

type: enum
6.39
OperatingStandards
Device.WiFi.NeighboringWiFiDiagnostic.Result.{i}.OperatingStandards
-
List items indicate which IEEE 802.11 standard that is detected for this Result..

Each value indicates support for the indicated standard.

If OperatingFrequencyBand is set to 2.4GHz, only values b, g, n are allowed.

If OperatingFrequencyBand is set to 5GHz, only values a, n, ac are allowed.

For example, a value of "g,b" (or "b,g" - order is not important) means that the 802.11g standard [802.11g-2003] is used with a backwards-compatible mode for 802.11b [802.11b-1999]. A value of "g" means that only the 802.11g standard can be used.

type: list<string>
6.39
OperatingChannelBandwidth
Device.WiFi.NeighboringWiFiDiagnostic.Result.{i}.OperatingChannelBandwidth
-
Indicates the bandwidth at which the channel is operating.

  • 20MHz
  • 40MHz
  • 80MHz

type: enum
6.39
Noise
Device.WiFi.NeighboringWiFiDiagnostic.Result.{i}.Noise
-
Indicator of average noise strength (in dBm) received from the neighboring WiFi radio.

type: int32[-200:]
6.39
W
WiFi SSID table (a stackable interface object as described in [TR-181i2]), where table entries model the MAC layer. A WiFi SSID entry is typically stacked on top of a #.Radio object.

WiFi SSID is also a multiplexing layer, i.e. more than one {i}. can be stacked above a single #.Radio.

In ROS there will always be a linked "main" SSID instance for each Radio instance, which can't be removed. Every SSID record, which is not linked from valid AccessPoint will be configured as =mode=(unknown) in ROS.

ROS: /interface wireless
Enable
Device.WiFi.SSID.{i}.Enable
W
Enables or disables the SSID entry.

This parameter is based on ''ifAdminStatus'' from [RFC2863].

In ROS "main" SSID can't be disabled directly. Respective Radio must be disabled, but that also disables all related SSIDs.
type: bool , default: "false"
ROS: /interface wireless =disabled
6.39
Status
Device.WiFi.SSID.{i}.Status
-
The current operational state of the SSID entry (see [TR-181i2]).

When Enable is false then Status SHOULD normally be Down (or NotPresent or Error if there is a fault condition on the interface).

When Enable is changed to true then Status SHOULD change to Up if and only if the interface is able to transmit and receive network traffic; it SHOULD change to Dormant if and only if the interface is operable but is waiting for external actions before it can transmit and receive network traffic (and subsequently change to Up if still operable when the expected actions have completed); it SHOULD change to LowerLayerDown if and only if the interface is prevented from entering the Up state because one or more of the interfaces beneath it is down; it SHOULD remain in the Error state if there is an error or other fault condition detected on the interface; it SHOULD remain in the NotPresent state if the interface has missing (typically hardware) components; it SHOULD change to Unknown if the state of the interface can not be determined for some reason.

This parameter is based on ''ifOperStatus'' from [RFC2863].

  • Up
  • Down
  • Unknown
  • Dormant
  • NotPresent
  • LowerLayerDown
  • Error

type: enum , default: "Down"
6.39
LowerLayers
Device.WiFi.SSID.{i}.LowerLayers
W
See [TR-181i2].

type: list<strongRef>(1024) , default: ""
6.39
BSSID
Device.WiFi.SSID.{i}.BSSID
-
The Basic Service Set ID.

This is the MAC address of the access point, which can either be local (when this instance models an access point SSID) or remote (when this instance models an end point SSID).

type: MACAddress
ROS: /interface wireless =mac-address
6.39
MACAddress
Device.WiFi.SSID.{i}.MACAddress
-
The MAC address of this interface.

If this instance models an access point SSID, MACAddress is the same as BSSID.

Note: This is not necessarily the same as the Ethernet header source or destination MAC address, which is associated with the IP interface and is modeled via the Device.Ethernet.Link.{i}.MACAddress parameter.

type: MACAddress
ROS: /interface wireless =mac-address
6.39
SSID
Device.WiFi.SSID.{i}.SSID
W
The current service set identifier in use by the connection. The SSID is an identifier that is attached to packets sent over the wireless LAN that functions as an ID for joining a particular radio network (BSS).

type: string(32)
ROS: /interface wireless =ssid
6.39
-
Throughput statistics for this interface. Packet counters here count 802.11 WiFi frames. See [TR-181i2a5] for further details. The CPE MUST reset the interface's Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface's Device.WiFi.SSID.{i}.Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface's Device.WiFi.SSID.{i}.Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [TR-181i2a5].

6.39
BytesSent
Device.WiFi.SSID.{i}.Stats.BytesSent
-
The total number of bytes transmitted out of the interface, including framing characters.

type: uint64 , flags: deny-active-notif
6.39
BytesReceived
Device.WiFi.SSID.{i}.Stats.BytesReceived
-
The total number of bytes received on the interface, including framing characters.

type: uint64 , flags: deny-active-notif
6.39
PacketsSent
Device.WiFi.SSID.{i}.Stats.PacketsSent
-
The total number of packets transmitted out of the interface.

type: uint64 , flags: deny-active-notif
6.39
PacketsReceived
Device.WiFi.SSID.{i}.Stats.PacketsReceived
-
The total number of packets received on the interface.

type: uint64 , flags: deny-active-notif
6.39
ErrorsSent
Device.WiFi.SSID.{i}.Stats.ErrorsSent
-
The total number of outbound packets that could not be transmitted because of errors. These can be due to the number of retransmissions exceeding the retry limit, or from other causes.

type: uint32
6.39
ErrorsReceived
Device.WiFi.SSID.{i}.Stats.ErrorsReceived
-
The total number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol.

type: uint32 , flags: deny-active-notif
6.39
DiscardPacketsSent
Device.WiFi.SSID.{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.

type: uint32 , flags: deny-active-notif
6.39
DiscardPacketsReceived
Device.WiFi.SSID.{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.

type: uint32 , flags: deny-active-notif
6.39
W
This object models an 802.11 connection from the perspective of a wireless access point. Each {i}. entry is associated with a particular #.SSID interface instance via the SSIDReference parameter.

For enabled table entries, if SSIDReference is not a valid reference then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured.

Each enabled record with configured SSIDReference, is managing the respective SSID/WLAN record in /interface/wireless using =mode=ap-bridge. Disabling or unsetting SSIDReference will set =mode=(unknown) for respective wlan.
Enable
Device.WiFi.AccessPoint.{i}.Enable
W
Enables or disables this access point.

type: bool , default: "false"
6.39
Status
Device.WiFi.AccessPoint.{i}.Status
-
Indicates the status of this access point.

The Error_Misconfigured value indicates that a necessary configuration value is undefined or invalid.

The Error value MAY be used by the CPE to indicate a locally defined error condition.

  • Disabled
  • Enabled
  • Error_Misconfigured
  • Error

type: enum , default: "Disabled"
6.39
SSIDReference
Device.WiFi.AccessPoint.{i}.SSIDReference
W


type: strongRef(256) , default: ""
6.39
SSIDAdvertisementEnabled
Device.WiFi.AccessPoint.{i}.SSIDAdvertisementEnabled
W
Indicates whether or not beacons include the SSID name.

type: bool , default: "true"
6.39
AssociatedDeviceNumberOfEntries
Device.WiFi.AccessPoint.{i}.AssociatedDeviceNumberOfEntries
-
The number of entries in the AssociatedDevice table.

type: uint32 , default: "0"
6.39
-
This object contains security related parameters that apply to a CPE acting as an Access Point [802.11-2007].

6.39
ModesSupported
Device.WiFi.AccessPoint.{i}.Security.ModesSupported
-
Indicates which security modes this # instance is capable of supporting.

  • None
  • WPA-Personal
  • WPA2-Personal
  • WPA-WPA2-Personal
  • WPA-Enterprise
  • WPA2-Enterprise
  • WPA-WPA2-Enterprise
  • X_MIKROTIK_Specific

type: list<enum> , default: "None,WPA-Personal,WPA2-Personal,WPA-WPA2-Personal,WPA-Enterprise,WPA2-Enterprise,WPA-WPA2-Enterprise,X_MIKROTIK_Specific"
6.39
ModeEnabled
Device.WiFi.AccessPoint.{i}.Security.ModeEnabled
W
Indicates which security mode is enabled.

type: string , default: "None"
6.39
KeyPassphrase
Device.WiFi.AccessPoint.{i}.Security.KeyPassphrase
W
A passphrase from which the PreSharedKey is to be generated, for WPA-Personal or WPA2-Personal or WPA-WPA2-Personal security modes.

type: string(8:63) , flags: hidden
6.39
-
A table of the devices currently associated with the access point.

MACAddress
Device.WiFi.AccessPoint.{i}.AssociatedDevice.{i}.MACAddress
-
The MAC address of an associated device.

type: MACAddress , flags: deny-active-notif
6.39
AuthenticationState
Device.WiFi.AccessPoint.{i}.AssociatedDevice.{i}.AuthenticationState
-
Whether an associated device has authenticated (true) or not (false).

type: bool , flags: deny-active-notif
6.39
SignalStrength
Device.WiFi.AccessPoint.{i}.AssociatedDevice.{i}.SignalStrength
-
An indicator of radio signal strength of the uplink from the associated device to the access point, measured in dBm, as an average of the last 100 packets received from the device.

type: int32[-200:]
6.39
-
These count bytes or packets sent to, or received from, this Associated Device, which is a WiFi station associated to this access point. Packet counters here count 802.11 WiFi frames.

6.39
BytesSent
Device.WiFi.AccessPoint.{i}.AssociatedDevice.{i}.Stats.BytesSent
-
The total number of bytes transmitted to the Associated Device, including framing characters.

type: StatsCounter64
6.39
BytesReceived
Device.WiFi.AccessPoint.{i}.AssociatedDevice.{i}.Stats.BytesReceived
-
The total number of bytes received from the Associated Device, including framing characters.

type: StatsCounter64
6.39
PacketsSent
Device.WiFi.AccessPoint.{i}.AssociatedDevice.{i}.Stats.PacketsSent
-
The total number of packets transmitted to the Associated Device.

type: StatsCounter64
6.39
PacketsReceived
Device.WiFi.AccessPoint.{i}.AssociatedDevice.{i}.Stats.PacketsReceived
-
The total number of packets received from the Associated Device.

type: StatsCounter64
6.39
-
Point-to-Point Protocol [RFC1661]. This object contains the Interface table.

6.39
InterfaceNumberOfEntries
Device.PPP.InterfaceNumberOfEntries
-
The number of entries in the Interface table.

type: uint32
6.39
W
PPP interface table (a stackable interface object as described in [TR-181i2]).

NOTE that Parameters can be changed only when X_MIKROTIK_Type is configured.
Enable
Device.PPP.Interface.{i}.Enable
W
Enables or disables the interface.

This parameter is based on ''ifAdminStatus'' from [RFC2863].

type: bool , default: "false"
6.39
Status
Device.PPP.Interface.{i}.Status
-
The current operational state of the interface (see [TR-181i2]).

When Enable is false then Status SHOULD normally be Down (or NotPresent or Error if there is a fault condition on the interface).

When Enable is changed to true then Status SHOULD change to Up if and only if the interface is able to transmit and receive network traffic; it SHOULD change to Dormant if and only if the interface is operable but is waiting for external actions before it can transmit and receive network traffic (and subsequently change to Up if still operable when the expected actions have completed); it SHOULD change to LowerLayerDown if and only if the interface is prevented from entering the Up state because one or more of the interfaces beneath it is down; it SHOULD remain in the Error state if there is an error or other fault condition detected on the interface; it SHOULD remain in the NotPresent state if the interface has missing (typically hardware) components; it SHOULD change to Unknown if the state of the interface can not be determined for some reason.

This parameter is based on ''ifOperStatus'' from [RFC2863].

  • Up
  • Down
  • Unknown
  • Dormant
  • NotPresent
  • LowerLayerDown
  • Error

type: enum , default: "Down"
6.39
LowerLayers
Device.PPP.Interface.{i}.LowerLayers
W
See [TR-181i2].

type: list<strongRef>(1024) , default: ""
6.39
ConnectionStatus
Device.PPP.Interface.{i}.ConnectionStatus
-
Current status of the connection.

  • Unconfigured
  • Connecting
  • Authenticating
  • Connected
  • PendingDisconnect
  • Disconnecting
  • Disconnected

type: enum , default: "Unconfigured"
6.39
AutoDisconnectTime
Device.PPP.Interface.{i}.AutoDisconnectTime
W
The time in seconds since the establishment of the connection after which connection termination is automatically initiated by the CPE. This occurs irrespective of whether the connection is being used or not. A value of 0 (zero) indicates that the connection is not to be shut down automatically.

type: uint32 , default: "0"
6.39
IdleDisconnectTime
Device.PPP.Interface.{i}.IdleDisconnectTime
W
The time in seconds that if the connection remains idle, the CPE automatically terminates the connection. A value of 0 (zero) indicates that the connection is not to be shut down automatically.

type: uint32 , default: "0"
6.39
Username
Device.PPP.Interface.{i}.Username
W
Username to be used for authentication.

type: string(64)
6.39
Password
Device.PPP.Interface.{i}.Password
W
Password to be used for authentication.

type: string(64) , flags: hidden
6.39
EncryptionProtocol
Device.PPP.Interface.{i}.EncryptionProtocol
-
Describes the PPP encryption protocol.

  • None
  • MPPE

type: enum
6.39
ConnectionTrigger
Device.PPP.Interface.{i}.ConnectionTrigger
W
Trigger used to establish the PPP connection.

Note that the reason for a PPP connection becoming disconnected to begin with might be either external to the CPE, such as termination by the BRAS or momentary disconnection of the physical interface, or internal to the CPE, such as use of the IdleDisconnectTime and/or AutoDisconnectTime parameters in this object.

  • OnDemand ( If this PPP connection is disconnected for any reason, it is to remain disconnected until the CPE has one or more packets to communicate over this connection, at which time the CPE automatically attempts to reestablish the connection. )
  • AlwaysOn ( If this PPP connection is disconnected for any reason, the CPE automatically attempts to reestablish the connection (and continues to attempt to reestablish the connection as long it remains disconnected). )

type: enum , default: "AlwaysOn"
6.39
X_MIKROTIK_Type
Device.PPP.Interface.{i}.X_MIKROTIK_Type
W
Type of PPP interface. Must be set after AddObject, so that ROS record of /interface pppoe-client is created
  • PPPoE

type: enum , default: ""
6.39
-
PPPoE object that functionally groups PPPoE related parameters.

6.39
ACName
Device.PPP.Interface.{i}.PPPoE.ACName
W
PPPoE Access Concentrator.

type: string(256)
6.39
ServiceName
Device.PPP.Interface.{i}.PPPoE.ServiceName
W
PPPoE Service Name.

type: string(256)
6.39
-
IP Control Protocol (IPCP) client object for this PPP interface [RFC1332]. IPCP. only applies to IPv4.

6.39
LocalIPAddress
Device.PPP.Interface.{i}.IPCP.LocalIPAddress
-
The local IPv4 address for this connection received via IPCP.

type: IPv4Address , default: ""
6.39
RemoteIPAddress
Device.PPP.Interface.{i}.IPCP.RemoteIPAddress
-
The remote IPv4 address for this connection received via IPCP.

type: IPv4Address , default: ""
6.39
-
Throughput statistics for this interface.

The CPE MUST reset the interface's Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface's Device.PPP.Interface.{i}.Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface's Device.PPP.Interface.{i}.Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [TR-181i2].

6.39
BytesSent
Device.PPP.Interface.{i}.Stats.BytesSent
-
The total number of bytes transmitted out of the interface, including framing characters.

type: uint64 , flags: deny-active-notif
6.39
BytesReceived
Device.PPP.Interface.{i}.Stats.BytesReceived
-
The total number of bytes received on the interface, including framing characters.

type: uint64 , flags: deny-active-notif
6.39
PacketsSent
Device.PPP.Interface.{i}.Stats.PacketsSent
-
The total number of packets transmitted out of the interface.

type: uint64 , flags: deny-active-notif
6.39
PacketsReceived
Device.PPP.Interface.{i}.Stats.PacketsReceived
-
The total number of packets received on the interface.

type: uint64 , flags: deny-active-notif
6.39
ErrorsSent
Device.PPP.Interface.{i}.Stats.ErrorsSent
-
The total number of outbound packets that could not be transmitted because of errors.

type: uint32 , flags: deny-active-notif
6.39
ErrorsReceived
Device.PPP.Interface.{i}.Stats.ErrorsReceived
-
The total number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol.

type: uint32 , flags: deny-active-notif
6.39
DiscardPacketsSent
Device.PPP.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.

type: uint32 , flags: deny-active-notif
6.39
DiscardPacketsReceived
Device.PPP.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.

type: uint32 , flags: deny-active-notif
6.39
-
IP object that contains the Interface, ActivePort, and Diagnostics objects.

6.39
InterfaceNumberOfEntries
Device.IP.InterfaceNumberOfEntries
-
The number of entries in the Interface table.

type: uint32
6.39
W
IP interface table (a stackable interface object as described in [TR-181i2]). This table models the layer 3 IP interface.

Enable
Device.IP.Interface.{i}.Enable
W
Enables or disables the interface (regardless of IPv4Enable and IPv6Enable).

This parameter is based on ''ifAdminStatus'' from [RFC2863].

type: bool , default: "false"
6.39
Status
Device.IP.Interface.{i}.Status
-
The current operational state of the interface (see [TR-181i2]).

This parameter is based on ''ifOperStatus'' from [RFC2863].

  • Up
  • Down
  • Unknown
  • Dormant
  • NotPresent
  • LowerLayerDown
  • Error

type: enum , default: "Down"
6.39
LowerLayers
Device.IP.Interface.{i}.LowerLayers
W
See [TR-181i2].

type: list<strongRef>(1024) , default: ""
6.39
IPv4AddressNumberOfEntries
Device.IP.Interface.{i}.IPv4AddressNumberOfEntries
-
The number of entries in the IPv4Address table.

type: uint32 , default: "0"
6.39
W
IPv4 address table. Entries are auto-created and auto-deleted as IP addresses are added and deleted via DHCP, auto-IP, or IPCP. Static entries are created and configured by the ACS.


ROS: /ip address
Enable
Device.IP.Interface.{i}.IPv4Address.{i}.Enable
W
Enables or disables this IPv4 address.

type: bool , default: "false"
ROS: /ip address =disabled
6.39
Status
Device.IP.Interface.{i}.IPv4Address.{i}.Status
-
The status of this IPv4Address. table entry.

The Error_Misconfigured value indicates that a necessary configuration value is undefined or invalid.

The Error value MAY be used by the CPE to indicate a locally defined error condition.

  • Disabled
  • Enabled
  • Error_Misconfigured
  • Error

type: enum , default: "Disabled"
6.39
IPAddress
Device.IP.Interface.{i}.IPv4Address.{i}.IPAddress
W
IPv4 address.

This parameter can only be modified if the AddressingType is Static.

type: IPv4Address , default: "255.255.255.255"
ROS: /ip address =address
6.39
SubnetMask
Device.IP.Interface.{i}.IPv4Address.{i}.SubnetMask
W
Subnet mask.

This parameter can only be modified if the AddressingType is Static.

type: IPv4Address , default: "255.255.255.255"
ROS: /ip address =address
6.39
AddressingType
Device.IP.Interface.{i}.IPv4Address.{i}.AddressingType
-
Addressing method used to assign the IP address.

  • Static
  • X_MIKROTIK_Dynamic

type: enum , default: "Static"
6.39
-
The IP Diagnostics object.

6.39
-
This object provides access to an IP-layer ping test.

6.39
DiagnosticsState
Device.IP.Diagnostics.IPPing.DiagnosticsState
W


  • None
  • Requested
  • Canceled
  • Complete
  • Error
  • Error_CannotResolveHostName
  • Error_NoRouteToHost ( The CPE can not reach the requested Ping host address )
  • Error_Internal
  • Error_Other

type: DiagnosticsState
6.39
Interface
Device.IP.Diagnostics.IPPing.Interface
W
The layer 2 or layer 3 interface over which the test is to be performed. Example: ''Device.IP.Interface.1'', ''Device.Bridge.1.Port.2''

If empty string is specified, the CPE MUST use the interface as directed by its bridging or routing policy (''Forwarding'' table entries) to determine the appropriate interface.

type: weakRef(256)
6.39
Host
Device.IP.Diagnostics.IPPing.Host
W
Host name or address of the host to ping.

In the case where Host is specified by name, and the name resolves to more than one address, it is up to the device implementation to choose which address to use.

type: string(256)
6.39
NumberOfRepetitions
Device.IP.Diagnostics.IPPing.NumberOfRepetitions
W
Number of repetitions of the ping test to perform before reporting the results.

type: uint32[1:]
6.39
Timeout
Device.IP.Diagnostics.IPPing.Timeout
W
Timeout in milliseconds for the ping test.

type: uint32[1:]
6.39
DataBlockSize
Device.IP.Diagnostics.IPPing.DataBlockSize
W
Size of the data block in bytes to be sent for each ping.

type: uint32[1:65535]
6.39
DSCP
Device.IP.Diagnostics.IPPing.DSCP
W
DiffServ codepoint to be used for the test packets. By default the CPE SHOULD set this value to zero.

type: uint32[:63]
6.39
SuccessCount
Device.IP.Diagnostics.IPPing.SuccessCount
-
Result parameter indicating the number of successful pings (those in which a successful response was received prior to the timeout) in the most recent ping test.

type: uint32 , flags: deny-active-notif
6.39
FailureCount
Device.IP.Diagnostics.IPPing.FailureCount
-
Result parameter indicating the number of failed pings in the most recent ping test.

type: uint32 , flags: deny-active-notif
6.39
AverageResponseTime
Device.IP.Diagnostics.IPPing.AverageResponseTime
-
Result parameter indicating the average response time in milliseconds over all repetitions with successful responses of the most recent ping test. If there were no successful responses, this value MUST be zero.

type: uint32 , flags: deny-active-notif
6.39
MinimumResponseTime
Device.IP.Diagnostics.IPPing.MinimumResponseTime
-
Result parameter indicating the minimum response time in milliseconds over all repetitions with successful responses of the most recent ping test. If there were no successful responses, this value MUST be zero.

type: uint32 , flags: deny-active-notif
6.39
MaximumResponseTime
Device.IP.Diagnostics.IPPing.MaximumResponseTime
-
Result parameter indicating the maximum response time in milliseconds over all repetitions with successful responses of the most recent ping test. If there were no successful responses, this value MUST be zero.

type: uint32 , flags: deny-active-notif
6.39
AverageResponseTimeDetailed
Device.IP.Diagnostics.IPPing.AverageResponseTimeDetailed
-
Result parameter indicating the average response time in microseconds over all repetitions with successful responses of the most recent ping test. If there were no successful responses, this value MUST be zero.

type: uint32 , flags: deny-active-notif
6.39
MinimumResponseTimeDetailed
Device.IP.Diagnostics.IPPing.MinimumResponseTimeDetailed
-
Result parameter indicating the minimum response time in microseconds over all repetitions with successful responses of the most recent ping test. If there were no successful responses, this value MUST be zero.

type: uint32 , flags: deny-active-notif
6.39
MaximumResponseTimeDetailed
Device.IP.Diagnostics.IPPing.MaximumResponseTimeDetailed
-
Result parameter indicating the maximum response time in microseconds over all repetitions with successful responses of the most recent ping test. If there were no successful responses, this value MUST be zero.

type: uint32 , flags: deny-active-notif
6.39
-
This object is defines access to an IP-layer trace-route test for the specified IP interface.

6.39
DiagnosticsState
Device.IP.Diagnostics.TraceRoute.DiagnosticsState
W


  • None
  • Requested
  • Canceled
  • Complete
  • Error
  • Error_CannotResolveHostName
  • Error_NoRouteToHost ( The CPE can not reach the requested TraceRoute host address )
  • Error_MaxHopCountExceeded
  • Error_Internal
  • Error_Other

type: DiagnosticsState
6.39
Interface
Device.IP.Diagnostics.TraceRoute.Interface
W
The layer 2 or layer 3 interface over which the test is to be performed. Example: ''Device.IP.Interface.1'', ''Device.Bridge.1.Port.2''

If empty string is specified, the CPE MUST use the interface as directed by its bridging or routing policy (''Forwarding'' table entries) to determine the appropriate interface.

type: weakRef(256)
6.39
Host
Device.IP.Diagnostics.TraceRoute.Host
W
Host name or address of the host to find a route to.

In the case where Host is specified by name, and the name resolves to more than one address, it is up to the device implementation to choose which address to use.

type: string(256)
6.39
NumberOfTries
Device.IP.Diagnostics.TraceRoute.NumberOfTries
W
Number of tries per hop. Set prior to running Diagnostic. By default, the CPE SHOULD set this value to 3.

type: uint32[1:3]
6.39
Timeout
Device.IP.Diagnostics.TraceRoute.Timeout
W
Timeout in milliseconds for each hop of the trace route test. By default the CPE SHOULD set this value to 5000.

type: uint32[1:]
6.39
DataBlockSize
Device.IP.Diagnostics.TraceRoute.DataBlockSize
W
Size of the data block in bytes to be sent for each trace route. By default, the CPE SHOULD set this value to 38.

type: uint32[1:65535]
6.39
DSCP
Device.IP.Diagnostics.TraceRoute.DSCP
W
DiffServ codepoint to be used for the test packets. By default the CPE SHOULD set this value to 0.

type: uint32[:63]
6.39
MaxHopCount
Device.IP.Diagnostics.TraceRoute.MaxHopCount
W
The maximum number of hop used in outgoing probe packets (max TTL). By default the CPE SHOULD set this value to 30.

type: uint32[1:64]
6.39
ResponseTime
Device.IP.Diagnostics.TraceRoute.ResponseTime
-
Result parameter indicating the response time in milliseconds the most recent trace route test. If a route could not be determined, this value MUST be zero.

type: uint32 , flags: deny-active-notif
6.39
RouteHopsNumberOfEntries
Device.IP.Diagnostics.TraceRoute.RouteHopsNumberOfEntries
-
The number of entries in the RouteHops table.

type: uint32 , flags: deny-active-notif
6.39
-
Contains the array of hop results returned. If a route could not be determined, this array will be empty

Host
Device.IP.Diagnostics.TraceRoute.RouteHops.{i}.Host
-
Result parameter indicating the Host Name if DNS is able to resolve or IP Address of a hop along the discovered route.

type: string(256) , flags: deny-active-notif
6.39
HostAddress
Device.IP.Diagnostics.TraceRoute.RouteHops.{i}.HostAddress
-
If this parameter is not empty string it will contain the last IP address of the host returned for this hop and the Host will contain the Host Name returned from the reverse DNS query.

type: string , flags: deny-active-notif
6.39
ErrorCode
Device.IP.Diagnostics.TraceRoute.RouteHops.{i}.ErrorCode
-
Contains the error code returned for this hop. This code is directly from the ICMP CODE field.

type: uint32 , flags: deny-active-notif
6.39
RTTimes
Device.IP.Diagnostics.TraceRoute.RouteHops.{i}.RTTimes
-
Each list item contains one or more round trip times in milliseconds (one for each repetition) for this hop.

A list item of 0 indicates that the corresponding response was not received. Round trip times of less than 1 milliseconds MUST be rounded up to 1.

The number of list entries is determined by the Device.IP.Diagnostics.TraceRoute.RouteHopsNumberOfEntries parameter.

type: list<uint32>(16)
6.39
-
This object defines the diagnostics configuration for a HTTP and FTP DownloadDiagnostics Test.

Files received in the DownloadDiagnostics do not require file storage on the CPE device.

6.42
DiagnosticsState
Device.IP.Diagnostics.DownloadDiagnostics.DiagnosticsState
W
Indicate the availability of diagnostic data.

If the ACS sets the value of this parameter to Requested, the CPE MUST initiate the corresponding diagnostic test. When writing, the only allowed value is 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 DiagnosticsState to 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 Completed (if the test completed successfully), or one of the ''Error'' values listed above.

If the value of this parameter is anything other than Completed, 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 None and remove all object instances from PerConnectionResult and IncrementalResult.

Modifying any of the writable parameters in this object except for this one MUST result in the value of this parameter being set to None and remove all object instances from PerConnectionResult and IncrementalResult.

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 None and remove all object instances from PerConnectionResult and IncrementalResult.

While the test is in progress, setting this parameter to 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.

  • None
  • Requested
  • Completed
  • Error_CannotResolveHostName
  • Error_NoRouteToHost
  • Error_InitConnectionFailed
  • Error_NoResponse
  • Error_TransferFailed
  • Error_PasswordRequestFailed
  • Error_LoginFailed
  • Error_NoTransferMode
  • Error_NoPASV
  • Error_IncorrectSize
  • Error_Timeout
  • Error_Internal
  • Error_Other

type: enum
6.42
DownloadURL
Device.IP.Diagnostics.DownloadDiagnostics.DownloadURL
W
The URL, as defined in [RFC3986], for the CPE to perform the download on. This parameter MUST be in the form of a valid HTTP [RFC2616] or FTP [RFC959] URL.

* When using FTP transport, FTP binary transfer MUST be used.

* When using HTTP transport, persistent connections MUST be used and pipelining MUST NOT be used.

* When using HTTP transport the HTTP Authentication MUST NOT be used.

Note: For time based tests (TimeBasedTestDuration > 0) the ACS MAY add a hint to duration of the test to the URL. See [TR-143a1] for more details.

type: string(256)
6.42
DSCP
Device.IP.Diagnostics.DownloadDiagnostics.DSCP
W
The DiffServ code point for marking packets transmitted in the test.

The default value SHOULD be zero.

type: uint32[:63]
6.42
EthernetPriority
Device.IP.Diagnostics.DownloadDiagnostics.EthernetPriority
W
Ethernet priority code for marking packets transmitted in the test (if applicable).

The default value SHOULD be zero.

type: uint32[:7]
6.42
ROMTime
Device.IP.Diagnostics.DownloadDiagnostics.ROMTime
-
Request time in UTC, which MUST be specified to microsecond precision.

For example: 2008-04-09T15:01:05.123456Z

* For HTTP this is the time at which the client sends the GET command.

* For FTP this is the time at which the client sends the RTRV command.

If multiple connections are used, then ROMTime is set to the earliest ROMTime across all connections.

type: UNKNOWN , flags: deny-active-notif
6.42
BOMTime
Device.IP.Diagnostics.DownloadDiagnostics.BOMTime
-
Begin of transmission time in UTC, which MUST be specified to microsecond precision

For example: 2008-04-09T15:01:05.123456Z

* For HTTP this is the time at which the first data packet is received.

* For FTP this is the time at which the client receives the first data packet on the data connection.

If multiple connections are used, then BOMTime is set to the earliest BOMTime across all connections.

type: UNKNOWN , flags: deny-active-notif
6.42
EOMTime
Device.IP.Diagnostics.DownloadDiagnostics.EOMTime
-
End of transmission in UTC, which MUST be specified to microsecond precision.

For example: 2008-04-09T15:01:05.123456Z

* For HTTP this is the time at which the last data packet is received.

* For FTP this is the time at which the client receives the last packet on the data connection.

If multiple connections are used, then EOMTime is set to the latest EOMTime across all connections.

type: UNKNOWN , flags: deny-active-notif
6.42
TestBytesReceived
Device.IP.Diagnostics.DownloadDiagnostics.TestBytesReceived
-
The number of bytes received during the FTP/HTTP transaction including FTP/HTTP headers, between BOMTime and EOMTime across all connections.

type: uint32
6.42
TotalBytesReceived
Device.IP.Diagnostics.DownloadDiagnostics.TotalBytesReceived
-
The total number of bytes (at the IP layer) received on the Interface between BOMTime and EOMTime. This MAY be calculated by sampling Stats.bytesReceived on the Interface object at BOMTime and at EOMTime and subtracting.

type: uint32
6.42
TCPOpenRequestTime
Device.IP.Diagnostics.DownloadDiagnostics.TCPOpenRequestTime
-
Request time in UTC, which MUST be specified to microsecond precision.

For example: 2008-04-09T15:01:05.123456Z

* For HTTP this is the time at which the TCP socket open (SYN) was sent for the HTTP connection.

* For FTP this is the time at which the TCP socket open (SYN) was sent for the data connection.

Note: Interval of 1 microsecond SHOULD be supported.

If multiple connections are used, then TCPOpenRequestTime is set to the latest TCPOpenRequestTime across all connections.

type: UNKNOWN , flags: deny-active-notif
6.42
TCPOpenResponseTime
Device.IP.Diagnostics.DownloadDiagnostics.TCPOpenResponseTime
-
Response time in UTC, which MUST be specified to microsecond precision.

For example: 2008-04-09T15:01:05.123456Z

* For HTTP this is the time at which the TCP ACK to the socket opening the HTTP connection was received.

* For FTP this is the time at which the TCP ACK to the socket opening the data connection was received.

Note: Interval of 1 microsecond SHOULD be supported.

If multiple connections are used, then TCPOpenResponseTime is set to the latest TCPOpenResponseTime across all connections.

type: UNKNOWN , flags: deny-active-notif
6.42
-
This object defines the diagnostics configuration for a HTTP or FTP UploadDiagnostics test.

Files sent by the UploadDiagnostics do not require file storage on the CPE device, and MAY be an arbitrary stream of bytes.

6.42
DiagnosticsState
Device.IP.Diagnostics.UploadDiagnostics.DiagnosticsState
W
Indicate the availability of diagnostic data.

If the ACS sets the value of this parameter to Requested, the CPE MUST initiate the corresponding diagnostic test. When writing, the only allowed value is 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 DiagnosticsState to 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 Completed (if the test completed successfully), or one of the ''Error'' values listed above.

If the value of this parameter is anything other than Completed, 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 None and remove all object instances from PerConnectionResult and IncrementalResult.

Modifying any of the writable parameters in this object except for this one MUST result in the value of this parameter being set to None and remove all object instances from PerConnectionResult and IncrementalResult.

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 None and remove all object instances from PerConnectionResult and IncrementalResult.

While the test is in progress, setting this parameter to 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.

  • None
  • Requested
  • Completed
  • Error_CannotResolveHostName
  • Error_NoRouteToHost
  • Error_InitConnectionFailed
  • Error_NoResponse
  • Error_PasswordRequestFailed
  • Error_LoginFailed
  • Error_NoTransferMode
  • Error_NoPASV
  • Error_NoCWD
  • Error_NoSTOR
  • Error_NoTransferComplete
  • Error_Timeout
  • Error_Internal
  • Error_Other

type: enum
6.42
UploadURL
Device.IP.Diagnostics.UploadDiagnostics.UploadURL
W
The URL, as defined in [RFC3986], for the CPE to Upload to. This parameter MUST be in the form of a valid HTTP [RFC2616] or FTP [RFC959] URL.

* When using FTP transport, FTP binary transfer MUST be used.

* When using HTTP transport, persistent connections MUST be used and pipelining MUST NOT be used.

* When using HTTP transport the HTTP Authentication MUST NOT be used.

type: string(256)
6.42
DSCP
Device.IP.Diagnostics.UploadDiagnostics.DSCP
W
DiffServ code point for marking packets transmitted in the test.

The default value SHOULD be zero.

type: uint32[:63]
6.42
EthernetPriority
Device.IP.Diagnostics.UploadDiagnostics.EthernetPriority
W
Ethernet priority code for marking packets transmitted in the test (if applicable).

The default value SHOULD be zero.

type: uint32[:7]
6.42
TestFileLength
Device.IP.Diagnostics.UploadDiagnostics.TestFileLength
W
The size of the file (in bytes) to be uploaded to the server.

The CPE MUST insure the appropriate number of bytes are sent.

type: uint32
6.42
ROMTime
Device.IP.Diagnostics.UploadDiagnostics.ROMTime
-
Request time in UTC, which MUST be specified to microsecond precision.

For example: 2008-04-09T15:01:05.123456Z

* For HTTP this is the time at which the client sends the GET command.

* For FTP this is the time at which the client sends the RTRV command.

If multiple connections are used, then ROMTime is set to the earliest ROMTime across all connections.

type: UNKNOWN , flags: deny-active-notif
6.42
BOMTime
Device.IP.Diagnostics.UploadDiagnostics.BOMTime
-
Begin of transmission time in UTC, which MUST be specified to microsecond precision

For example: 2008-04-09T15:01:05.123456Z

* For HTTP this is the time at which the first data packet is received.

* For FTP this is the time at which the client receives the first data packet on the data connection.

If multiple connections are used, then BOMTime is set to the earliest BOMTime across all connections.

type: UNKNOWN , flags: deny-active-notif
6.42
EOMTime
Device.IP.Diagnostics.UploadDiagnostics.EOMTime
-
End of transmission in UTC, which MUST be specified to microsecond precision.

For example: 2008-04-09T15:01:05.123456Z

* For HTTP this is the time at which the last data packet is received.

* For FTP this is the time at which the client receives the last packet on the data connection.

If multiple connections are used, then EOMTime is set to the latest EOMTime across all connections.

type: UNKNOWN , flags: deny-active-notif
6.42
TotalBytesSent
Device.IP.Diagnostics.UploadDiagnostics.TotalBytesSent
-
The total number of bytes (at the IP layer) sent on the Interface between BOMTime and EOMTime. This MAY be calculated by sampling Stats.bytesSent on the Interface object at BOMTime and at EOMTime and subtracting.

type: uint32
6.42
TCPOpenRequestTime
Device.IP.Diagnostics.UploadDiagnostics.TCPOpenRequestTime
-
Request time in UTC, which MUST be specified to microsecond precision.

For example: 2008-04-09T15:01:05.123456Z

* For HTTP this is the time at which the TCP socket open (SYN) was sent for the HTTP connection.

* For FTP this is the time at which the TCP socket open (SYN) was sent for the data connection.

Note: Interval of 1 microsecond SHOULD be supported.

If multiple connections are used, then TCPOpenRequestTime is set to the latest TCPOpenRequestTime across all connections.

type: UNKNOWN , flags: deny-active-notif
6.42
TCPOpenResponseTime
Device.IP.Diagnostics.UploadDiagnostics.TCPOpenResponseTime
-
Response time in UTC, which MUST be specified to microsecond precision.

For example: 2008-04-09T15:01:05.123456Z

* For HTTP this is the time at which the TCP ACK to the socket opening the HTTP connection was received.

* For FTP this is the time at which the TCP ACK to the socket opening the data connection was received.

Note: Interval of 1 microsecond SHOULD be supported.

If multiple connections are used, then TCPOpenResponseTime is set to the latest TCPOpenResponseTime across all connections.

type: UNKNOWN , flags: deny-active-notif
6.42
-
Routing object that contains the Router table and RIP protocol object.

6.39
RouterNumberOfEntries
Device.Routing.RouterNumberOfEntries
-
The number of entries in the Router table.

type: uint32
6.39
-
This object allows the handling of the routing and forwarding configuration of the device.

Current implementation will contain 1 read-only Router object.
Enable
Device.Routing.Router.{i}.Enable
-
Currently always enabled

type: bool , default: "false"
6.39
Status
Device.Routing.Router.{i}.Status
-
Currently always "Enabled"

  • Disabled
  • Enabled
  • Error

type: enum , default: "Disabled"
6.39
IPv4ForwardingNumberOfEntries
Device.Routing.Router.{i}.IPv4ForwardingNumberOfEntries
-
The number of entries in the IPv4Forwarding table.

type: uint32 , default: "0"
6.39
W
Layer 3 IPv4 forwarding table.

In addition to statically configured routes, this table MUST include dynamic routes learned through layer 3 routing protocols, including RIP (i.e. RIP version 2), OSPF, DHCPv4, and IPCP. The CPE MAY reject attempts to delete or modify a dynamic route entry.

For each incoming packet, the layer 3 forwarding decision is conceptually made as follows:

* Only enabled table entries with a matching ForwardingPolicy are considered, i.e. those that either do not specify a ForwardingPolicy, or else specify a ForwardingPolicy that matches that of the incoming packet.

* Next, table entries that also have a matching destination address/mask are considered, and the matching entry with the longest prefix is applied to the packet (i.e. the entry with the most specific network). An unspecified destination address is a wild-card and always matches, but with a prefix length of zero.

For enabled table entries, if Interface is not a valid reference to an IPv4-capable interface (that is attached to the IPv4 stack), then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured.

Note: The {i}. table includes a unique key parameter that is a strong reference. If a strongly referenced object is deleted, the CPE will set the referencing parameter to empty string. However, doing so under these circumstances might cause the updated {i}. row to then violate the table's unique key constraint; if this occurs, the CPE MUST disable the offending {i}. row.


ROS: /ip route
Enable
Device.Routing.Router.{i}.IPv4Forwarding.{i}.Enable
W
Enables or disables the forwarding entry. On creation, an entry is disabled by default.

type: bool , default: "false"
ROS: /ip route =disabled
6.39
Status
Device.Routing.Router.{i}.IPv4Forwarding.{i}.Status
-
Indicates the status of the forwarding entry.

The Error value MAY be used by the CPE to indicate a locally defined error condition.

The Error_Misconfigured value indicates that a necessary configuration value is undefined or invalid.

  • Disabled
  • Enabled
  • Error_Misconfigured
  • Error

type: enum , default: "Disabled"
6.39
StaticRoute
Device.Routing.Router.{i}.IPv4Forwarding.{i}.StaticRoute
-
If true, this route is a Static route.

type: bool , default: "true"
6.39
DestIPAddress
Device.Routing.Router.{i}.IPv4Forwarding.{i}.DestIPAddress
W
Destination IPv4 address. empty string indicates no destination address is specified.

A Forwarding table entry for which DestIPAddress and DestSubnetMask are both empty string is a default route.

type: IPv4Address , default: ""
ROS: /ip route =dst-address
6.39
DestSubnetMask
Device.Routing.Router.{i}.IPv4Forwarding.{i}.DestSubnetMask
W
Destination subnet mask. empty string indicates no destination subnet mask is specified.

If a destination subnet mask is specified, the DestSubnetMask is ANDed with the destination address before comparing with the DestIPAddress. Otherwise, the full destination address is used as is.

A Forwarding table entry for which DestIPAddress and DestSubnetMask are both empty string is a default route.

type: IPv4Address , default: ""
ROS: /ip route =dst-address
6.39
GatewayIPAddress
Device.Routing.Router.{i}.IPv4Forwarding.{i}.GatewayIPAddress
W
IPv4 address of the gateway.

Only one of GatewayIPAddress and Interface SHOULD be configured for a route.

If both are configured, GatewayIPAddress and Interface MUST be consistent with each other.

type: IPv4Address , default: ""
ROS: /ip route =gateway
6.39
Interface
Device.Routing.Router.{i}.IPv4Forwarding.{i}.Interface
W
Specifies the egress layer 3 interface associated with this entry. Example: Device.IP.Interface.1.

Only one of GatewayIPAddress and Interface SHOULD be configured for a route.

If both are configured, GatewayIPAddress and Interface MUST be consistent with each other.

For a route that was configured by setting GatewayIPAddress but not Interface, read access to Interface MUST return the full hierarchical parameter name for the routes egress interface.

type: strongRef(256) , default: ""
ROS: /ip route =gateway
6.39
Origin
Device.Routing.Router.{i}.IPv4Forwarding.{i}.Origin
-
Protocol via which the IPv4 forwarding rule was learned.

  • OSPF
  • RIP
  • Static ( For example, present in the factory default configuration, created by the ACS, or created by some other management entity (e.g. via a GUI). )
  • X_MIKROTIK_Connect
  • X_MIKROTIK_Dynamic_Static
  • X_MIKROTIK_BGP

type: enum , default: "Static"
6.39
-
This object provides information about each of the hosts on the LAN, including those whose IP address was allocated by the CPE using DHCP as well as hosts with statically allocated IP addresses. It can also include non-IP hosts.

6.39
HostNumberOfEntries
Device.Hosts.HostNumberOfEntries
-
The number of entries in the Host table.

type: uint32
6.39
-
Host table.

PhysAddress
Device.Hosts.Host.{i}.PhysAddress
-
Unique physical identifier of the host. For many layer 2 technologies this is typically a MAC address.

type: string(64)
6.39
IPAddress
Device.Hosts.Host.{i}.IPAddress
-
Current IP Address of the host. empty string if no address is available.

If more than one IP address for this host is known, the CPE will choose a ''primary'' address. All known IP addresses can be listed in the IPv4Address and IPv6Address tables.

type: IPAddress
6.39
DHCPClient
Device.Hosts.Host.{i}.DHCPClient
-
Each list item is the DHCPv4 or DHCPv6 server's client entry that corresponds to the host.

type: list<strongRef>
6.39
AssociatedDevice
Device.Hosts.Host.{i}.AssociatedDevice
-
The value MUST the path name of the ''AssociatedDevice'' (or equivalent) table row that models the host, or null if there is no such table.

For example: ''Device.WiFi.AccessPoint.1.AssociatedDevice.2''

type: strongRef(256)
6.39
Layer1Interface
Device.Hosts.Host.{i}.Layer1Interface
-
The value MUST be the path name of a row in a layer 1 interface table. If the layer 1 device isn’t known, then Layer1Interface will be null.

For example: ''Device.Ethernet.Interface.2''

type: strongRef(256)
6.39
Layer3Interface
Device.Hosts.Host.{i}.Layer3Interface
-
If the entry represents a non-IP device, then Layer3Interface will be empty string.

type: strongRef(256)
6.39
HostName
Device.Hosts.Host.{i}.HostName
-
The device's host name or empty string if unknown.

type: string(64)
6.39
-
Properties for Domain Name Service (DNS).

6.39
-
Client properties for Domain Name Service (DNS). The DNS client resolves FQDN on behalf of device internal (client) applications.

6.39
ServerNumberOfEntries
Device.DNS.Client.ServerNumberOfEntries
-
The number of entries in the Server table.

type: uint32
6.39
W
This table contains the DNS Server IP address to be used by the DHCP Client (it does ''not'' model a DNS Server). Entries are either automatically created as result of DHCP (v4 or v6), IPCP, or RA received DNS server information, or are statically configured by the ACS.

Enable
Device.DNS.Client.Server.{i}.Enable
W
Enables or disables this entry.

type: bool , default: "false"
6.39
Status
Device.DNS.Client.Server.{i}.Status
-
The status of this entry.

The Error value MAY be used by the CPE to indicate a locally defined error condition.

  • Disabled
  • Enabled
  • Error

type: enum , default: "Disabled"
6.39
DNSServer
Device.DNS.Client.Server.{i}.DNSServer
W
DNS server IP addresses.

Note: DNSServer is only writable when Type is Static; otherwise, DNSServer is automatically configured as result of DHCP, IPCP, or RA received DNS server information.

type: IPAddress
6.39
Type
Device.DNS.Client.Server.{i}.Type
-
Method used to assign the DNSServer address.

Table entries that are automatically created as result of DHCP, IPCP, or RA received DNS server information will have Type set to DHCPv4, DHCPv6, IPCP, or RouterAdvertisement, as the case may be. Manually created table entires will have their Type set to Static.

  • Static
  • X_MIKROTIK_Dynamic

type: enum , default: "Static"
6.39
-
The Dynamic Host Configuration Protocol (DHCP) IPv4 object [RFC2131]. This entire object applies to IPv4 only. It contains the Client, Server, and Relay objects.

6.39
ClientNumberOfEntries
Device.DHCPv4.ClientNumberOfEntries
-
The number of entries in the Client table.

type: uint32
6.39
W
This object contains DHCP client settings for an associated ''IP Interface'' indicated by Interface.

For enabled table entries, if Interface is not a valid reference then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured.

Note: The {i}. table includes a unique key parameter that is a strong reference. If a strongly referenced object is deleted, the CPE will set the referencing parameter to empty string. However, doing so under these circumstances might cause the updated {i}. row to then violate the table's unique key constraint; if this occurs, the CPE MUST set Status to Error_Misconfigured and disable the offending {i}. row.


ROS: /ip dhcp-client
Enable
Device.DHCPv4.Client.{i}.Enable
W
Enables or disables the DHCP Client entry.

type: bool , default: "false"
ROS: /ip dhcp-client =disabled
6.39
Interface
Device.DHCPv4.Client.{i}.Interface
W
The IP Interface associated with the ''Client'' entry.

type: strongRef(256) , default: ""
ROS: /ip dhcp-client =interface
6.39
Status
Device.DHCPv4.Client.{i}.Status
-
The status of this table entry.

The Error_Misconfigured value indicates that a necessary configuration value is undefined or invalid.

The Error value MAY be used by the CPE to indicate a locally defined error condition.

  • Disabled
  • Enabled
  • Error_Misconfigured
  • Error

type: enum , default: "Disabled"
6.39
DHCPStatus
Device.DHCPv4.Client.{i}.DHCPStatus
-
The DHCP Client status as defined in [RFC2131].

Note: This value is only relevant when the DHCP Client is operationally enabled (i.e. when Status is Enabled).

  • Init
  • Selecting
  • Requesting
  • Rebinding
  • Bound
  • Renewing

type: enum
6.39
IPAddress
Device.DHCPv4.Client.{i}.IPAddress
-
IPv4 Address option received from the DHCP Server. empty string when Status is not equal to Bound.

type: IPv4Address , default: ""
6.39
SubnetMask
Device.DHCPv4.Client.{i}.SubnetMask
-
Subnet mask option received from the DHCP Server. empty string when Status is not equal to Bound.

Value is information received via DHCP Option 1.

type: IPv4Address , default: ""
6.39
IPRouters
Device.DHCPv4.Client.{i}.IPRouters
-
Items represent IP Router IPv4 Address(es) received from the DHCP server. empty string when Status is not equal to Bound.

Value is information received via DHCP Options 3, 33 or 121.

type: list<IPv4Address>(256) , default: ""
6.39
DNSServers
Device.DHCPv4.Client.{i}.DNSServers
-
Items represent DNS Server IPv4 Address(es) received from the DHCP server. empty string when Status is not equal to Bound.

Value is information received via DHCP Option 6.

type: list<IPv4Address>(256) , default: ""
6.39
DHCPServer
Device.DHCPv4.Client.{i}.DHCPServer
-
The IPv4 address of the current DHCP server.

type: IPv4Address , default: ""
6.39
-
DHCP server configuration.

6.39
PoolNumberOfEntries
Device.DHCPv4.Server.PoolNumberOfEntries
-
The number of entries in the Pool table.

type: uint32
6.39
W
This object in ROS works a bit different than standard one, because ROS has non-typical DHCP server configuration design. Parameters are reused from standard and should work the same for 99% of configurations where there is one DHCP server for each interface and one network for each DHCP server.

Each instance maps to "/ip dhcp-server" record and manages respective "/ip dhcp-server network" automatically.


ROS: /ip dhcp-server
Enable
Device.DHCPv4.Server.Pool.{i}.Enable
W
Enables or disables the Pool entry.

type: bool , default: "false"
ROS: /ip dhcp-server =disabled
6.39
Status
Device.DHCPv4.Server.Pool.{i}.Status
-
The status of this entry.

The Error_Misconfigured value indicates that a necessary configuration value is undefined or invalid.

The Error value MAY be used by the CPE to indicate a locally defined error condition.

  • Disabled
  • Enabled
  • Error_Misconfigured
  • Error

type: enum , default: "Disabled"
6.39
Interface
Device.DHCPv4.Server.Pool.{i}.Interface
W
The IP Interface associated with the ''Pool'' entry.

type: strongRef(256) , default: ""
ROS: /ip dhcp-server =interface
6.39
MinAddress
Device.DHCPv4.Server.Pool.{i}.MinAddress
W
Specifies first IPv4 address in the pool to be assigned by the DHCP server on the LAN interface.

Must be set together with MaxAddress.

type: IPv4Address
ROS: /ip pool =ranges
6.39
MaxAddress
Device.DHCPv4.Server.Pool.{i}.MaxAddress
W
Specifies last IPv4 address in the pool to be assigned by the DHCP server on the LAN interface.

Must be set together with MinAddress.

type: IPv4Address
ROS: /ip pool =ranges
6.39
SubnetMask
Device.DHCPv4.Server.Pool.{i}.SubnetMask
W
Specifies the client's network subnet mask.

MinAddress and MaxAddress must be set.

type: IPv4Address
ROS: /ip dhcp-server network =address
6.39
DNSServers
Device.DHCPv4.Server.Pool.{i}.DNSServers
W
List items represent DNS servers offered to DHCP clients.

MinAddress, MaxAddress and SubnetMask must be set.

type: list<IPv4Address>
ROS: /ip dhcp-server network =dns-server
6.39
DomainName
Device.DHCPv4.Server.Pool.{i}.DomainName
W
Sets the domain name to provide to clients on the LAN interface.

MinAddress, MaxAddress and SubnetMask must be set.

type: string(64)
ROS: /ip dhcp-server network =domain
6.39
IPRouters
Device.DHCPv4.Server.Pool.{i}.IPRouters
W
List items represent addresses of routers on this subnet. Also known as default gateway. Support for more than one Router address is OPTIONAL.

MinAddress, MaxAddress and SubnetMask must be set.

type: list<IPv4Address>
ROS: /ip dhcp-server network =gateway
6.39
LeaseTime
Device.DHCPv4.Server.Pool.{i}.LeaseTime
W
Specifies the lease time in seconds of client assigned addresses.

type: int32[1:] , default: "86400"
ROS: /ip dhcp-server =lease-time
6.39
StaticAddressNumberOfEntries
Device.DHCPv4.Server.Pool.{i}.StaticAddressNumberOfEntries
-
The number of entries in the StaticAddress table.

type: uint32 , default: "0"
6.39
ClientNumberOfEntries
Device.DHCPv4.Server.Pool.{i}.ClientNumberOfEntries
-
The number of entries in the Client table.

type: uint32 , default: "0"
6.39
W
DHCP static address table.

Entries in this table correspond to what [RFC2131] calls "manual allocation", where a client's IP address is assigned by the network administrator, and DHCP is used simply to convey the assigned address to the client.

Each instance of this object specifies a hardware address (MAC address) and an IP address within the pool. When serving from this pool, this IP address MUST, if available, be assigned to the DHCP client with this hardware address, and MUST NOT be assigned to any other client.

Note that it is possible that an IP address in this table is present in one or more of the other conditional serving pools, in which case it is possible that such an address will be assigned to a different client.


ROS: /ip dhcp-server lease
Enable
Device.DHCPv4.Server.Pool.{i}.StaticAddress.{i}.Enable
W
Enables or disables the StaticAddress table entry.

Disabling an entry does not return the IP address to the pool.

type: bool , default: "false"
ROS: /ip dhcp-server lease =disabled
6.39
Chaddr
Device.DHCPv4.Server.Pool.{i}.StaticAddress.{i}.Chaddr
W
Hardware address (MAC address) of the physical interface of the DHCP client.

type: MACAddress , default: ""
ROS: /ip dhcp-server lease =address
6.39
Yiaddr
Device.DHCPv4.Server.Pool.{i}.StaticAddress.{i}.Yiaddr
W
IPv4 address to be assigned by the DHCP server to the DHCP client with the specified hardware address (MAC address).

type: IPv4Address , default: ""
ROS: /ip dhcp-server lease =max-address
6.39
-
DHCPv4 client table.

This table lists details of DHCPv4 clients that matched the filter criteria of this # entry.

Chaddr
Device.DHCPv4.Server.Pool.{i}.Client.{i}.Chaddr
-
MAC address of the DHCPv4 client.

type: MACAddress
6.39
IPv4AddressNumberOfEntries
Device.DHCPv4.Server.Pool.{i}.Client.{i}.IPv4AddressNumberOfEntries
-
The number of entries in the IPv4Address table.

type: uint32 , default: "0"
6.39
-
IPv4 addresses assigned to this client.

IPAddress
Device.DHCPv4.Server.Pool.{i}.Client.{i}.IPv4Address.{i}.IPAddress
-
IPv4 address.

type: IPv4Address
6.39
LeaseTimeRemaining
Device.DHCPv4.Server.Pool.{i}.Client.{i}.IPv4Address.{i}.LeaseTimeRemaining
-
The time at which the DHCP lease will expire or null if not known. For an infinite lease, the parameter value MUST be 9999-12-31T23:59:59Z.

type: UNKNOWN
6.39
-
For some unknown reason TR181-2 standard Firewall. object was created only to manage filter table's "forward" chain rules, which is very limited for security. ROS implementation extends this object to support "input", "output" and "forward" chains in filter table.

6.39
-
6.39
ChainNumberOfEntries
Device.Firewall.X_MIKROTIK_Filter.ChainNumberOfEntries
-
The number of entries in the Chain table.

type: uint32
6.39
W
Firewall Chain table. Each entry contains an ordered list of Rule objects which can themselves reference other {i}. instances. A hierarchy of rules can therefore be created.

NOTE that there are 3 default/non-editable chains - "forward", "input", "output"
Enable
Device.Firewall.X_MIKROTIK_Filter.Chain.{i}.Enable
W
Enables or disables this Chain. entry.

type: bool , default: "false"
6.39
Name
Device.Firewall.X_MIKROTIK_Filter.Chain.{i}.Name
W
Human-readable name associated with this Chain. entry.

type: string(64)
6.39
RuleNumberOfEntries
Device.Firewall.X_MIKROTIK_Filter.Chain.{i}.RuleNumberOfEntries
-
The number of entries in the Rule table.

type: uint32 , default: "0"
6.39
W
Firewall Rule table.

NOTE that most of Paramaters are similar to standard DM, but multiple of them are extended to have more functionality.


ROS: /ip firewall filter
Enable
Device.Firewall.X_MIKROTIK_Filter.Chain.{i}.Rule.{i}.Enable
W
Enables or disables this Rule. entry.

type: bool , default: "false"
ROS: /ip firewall filter =disabled
6.39
Order
Device.Firewall.X_MIKROTIK_Filter.Chain.{i}.Rule.{i}.Order
W
Position of the Rule. entry in the order of precedence. A value of ''1'' indicates the first entry considered (highest precedence). For each packet, the highest ordered entry that matches the rule criteria is applied. All lower order entries are ignored.

When this value is modified, if the value matches that of an existing entry, the Order value for the existing entry and all lower Order entries is incremented (lowered in precedence) to ensure uniqueness of this value. A deletion causes Order values to be compacted. When a value is changed, incrementing occurs before compaction.

The value of Order on creation of a Rule. table entry MUST be one greater than the largest current value (initially assigned the lowest precedence).

type: uint32[1:]
6.39
Description
Device.Firewall.X_MIKROTIK_Filter.Chain.{i}.Rule.{i}.Description
W
Human-readable description associated with this Rule. entry.

type: string(256)
ROS: /ip firewall filter =comment
6.39
Target
Device.Firewall.X_MIKROTIK_Filter.Chain.{i}.Rule.{i}.Target
W
Action to perform for traffic matching this Rule. entry.

  • Drop ( The firewall discards packets matching this rule. )
  • Accept ( The firewall forwards packets matching this rule. )
  • Reject ( The firewall discards packets matching this rule, and sends an ICMP message to the originating host. )
  • Return ( The firewall doesn't consider the remaining rules (if any) in the current chain. )
  • TargetChain ( The rules in the chain referenced by the {{param|TargetChain}} parameter are matched. )
  • Log
  • Passthrough
  • AddSrcToAddressList
  • AddDstToAddressList
  • Tarpit
  • FasttrackConnection

type: enum , default: "Drop"
ROS: /ip firewall filter =action
6.39
TargetChain
Device.Firewall.X_MIKROTIK_Filter.Chain.{i}.Rule.{i}.TargetChain
W
Specifies the chain to process when Target equals TargetChain. If there are no matching rules in the referenced chain, processing continues with the next rule in this chain (if any). In other words, TargetChain behaves like a subroutine call.

empty string indicates no TargetChain is specified.

type: strongRef , default: ""
ROS: /ip firewall filter =jump-target
6.39
Log
Device.Firewall.X_MIKROTIK_Filter.Chain.{i}.Rule.{i}.Log
W
Enable or disable logging, in a ###.DeviceInfo.VendorLogFile, of packets matching this Rule..

type: bool , default: "false"
ROS: /ip firewall filter =log
6.39
SourceInterfaceGroup
Device.Firewall.X_MIKROTIK_Filter.Chain.{i}.Rule.{i}.SourceInterfaceGroup
W
Rule. criterion. Group source interface.

Only one of SourceInterfaceGroup and SourceInterface SHOULD be configured at the same time. If SourceInterface is set, then value of this Parameter will be set to one-interface automatically and if this Parameter is set, then SourceInterface will be set to empty string automatically.

  • one-interface ( {{param|SourceInterface}} is used as the rule criterion. )
  • all
  • all-ethernet
  • all-wireless
  • all-vlan
  • all-ppp

type: enum , default: "all"
ROS: /ip firewall filter =in-interface
6.39
SourceInterface
Device.Firewall.X_MIKROTIK_Filter.Chain.{i}.Rule.{i}.SourceInterface
W
Rule. criterion. This specifies the ingress interface associated with the entry.

Only one of SourceInterfaceGroup and SourceInterface SHOULD be configured at the same time. If SourceInterfaceGroup is set, then value of this Parameter will be set to empty string automatically and if this Parameter is set, then SourceInterfaceGroup will be set to one-interface automatically.

type: strongRef(256) , default: ""
ROS: /ip firewall filter =in-interface
6.39
SourceInterfaceExclude
Device.Firewall.X_MIKROTIK_Filter.Chain.{i}.Rule.{i}.SourceInterfaceExclude
W
If false, the rule matches only those packets that match the SourceInterface or SourceInterfaceGroup entry, if specified.

If true, the rule matches all packets except those that match the SourceInterface or SourceInterfaceGroup entry, if specified.

type: bool , default: "false"
ROS: /ip firewall filter =in-interface
6.39
DestInterfaceGroup
Device.Firewall.X_MIKROTIK_Filter.Chain.{i}.Rule.{i}.DestInterfaceGroup
W
Rule. criterion. Group destination interface.

Only one of DestInterfaceGroup and DestInterface SHOULD be configured at the same time. If DestInterface is set, then value of this Parameter will be set to one-interface automatically and if this Parameter is set, then DestInterface will be set to empty string automatically.

  • one-interface ( {{param|DestInterface}} is used as the rule criterion. )
  • all
  • all-ethernet
  • all-wireless
  • all-vlan
  • all-ppp

type: enum , default: "all"
ROS: /ip firewall filter =out-interface
6.39
DestInterface
Device.Firewall.X_MIKROTIK_Filter.Chain.{i}.Rule.{i}.DestInterface
W
Rule. criterion. This specifies the egress interface associated with the entry.

Only one of DestInterfaceGroup and DestInterface SHOULD be configured at the same time. If DestInterfaceGroup is set, then value of this Parameter will be set to empty string automatically and if this Parameter is set, then DestInterfaceGroup will be set to one-interface automatically.

type: strongRef(256) , default: ""
ROS: /ip firewall filter =out-interface
6.39
DestInterfaceExclude
Device.Firewall.X_MIKROTIK_Filter.Chain.{i}.Rule.{i}.DestInterfaceExclude
W
If false, the rule matches only those packets that match the DestInterface or DestInterfaceGroup entry, if specified.

If true, the rule matches all packets except those that match the DestInterface or DestInterfaceGroup entry, if specified.

type: bool , default: "false"
ROS: /ip firewall filter =out-interface
6.39
DestIPRange
Device.Firewall.X_MIKROTIK_Filter.Chain.{i}.Rule.{i}.DestIPRange
W
Dest IP range.

type: IPv4AddressRange , default: ""
ROS: /ip firewall filter =dst-address
6.39
DestIPExclude
Device.Firewall.X_MIKROTIK_Filter.Chain.{i}.Rule.{i}.DestIPExclude
W
If false, the rule matches only those packets that match the DestIPRange entry, if specified.

If true, the rule matches all packets except those that match the DestIPRange entry, if specified.

type: bool , default: "false"
ROS: /ip firewall filter =dst-address
6.39
SourceIPRange
Device.Firewall.X_MIKROTIK_Filter.Chain.{i}.Rule.{i}.SourceIPRange
W
Source IP range.

type: IPv4AddressRange , default: ""
ROS: /ip firewall filter =src-address
6.39
SourceIPExclude
Device.Firewall.X_MIKROTIK_Filter.Chain.{i}.Rule.{i}.SourceIPExclude
W
If false, the rule matches only those packets that match the SourceIPRange entry, if specified.

If true, the rule matches all packets except those that match the SourceIPRange entry, if specified.

type: bool , default: "false"
ROS: /ip firewall filter =src-address
6.39
Protocol
Device.Firewall.X_MIKROTIK_Filter.Chain.{i}.Rule.{i}.Protocol
W
Rule. criterion.

Protocol number. A value of -1 indicates this criterion is not used for matching.

type: int32[-1:255] , default: "-1"
ROS: /ip firewall filter =protocol
6.39
ProtocolExclude
Device.Firewall.X_MIKROTIK_Filter.Chain.{i}.Rule.{i}.ProtocolExclude
W
If false, the rule matches only those packets that match the Protocol entry, if specified.

If true, the rule matches all packets except those that match the Protocol entry, if specified.

type: bool , default: "false"
ROS: /ip firewall filter =protocol
6.39
DestPortList
Device.Firewall.X_MIKROTIK_Filter.Chain.{i}.Rule.{i}.DestPortList
W
Destination port value. (e.g. - "1", "1-10", "1-10,20-30", "1,20,80,100-200").

type: list<Uint32Range> , default: ""
ROS: /ip firewall filter =dst-port
6.39
DestPortExclude
Device.Firewall.X_MIKROTIK_Filter.Chain.{i}.Rule.{i}.DestPortExclude
W
If false, the rule matches only those packets that match the DestPortList entry, if specified.

If true, the rule matches all packets except those that match the DestPortList, if specified.

type: bool , default: "false"
ROS: /ip firewall filter =dst-port
6.39
SourcePortList
Device.Firewall.X_MIKROTIK_Filter.Chain.{i}.Rule.{i}.SourcePortList
W
Source port value. (e.g. - "1", "1-10", "1-10,20-30", "1,20,80,100-200").

type: list<Uint32Range> , default: ""
ROS: /ip firewall filter =src-port
6.39
SourcePortExclude
Device.Firewall.X_MIKROTIK_Filter.Chain.{i}.Rule.{i}.SourcePortExclude
W
If false, the rule matches only those packets that match the SourcePortList entry, if specified.

If true, the rule matches all packets except those that match the SourcePortList entry, if specified.

type: bool , default: "false"
ROS: /ip firewall filter =src-port
6.39
ConnState
Device.Firewall.X_MIKROTIK_Filter.Chain.{i}.Rule.{i}.ConnState
W
Group destination interface if DestInterface not used.

  • Established
  • Invalid
  • New
  • Related
  • Untracked

type: list<enum> , default: ""
ROS: /ip firewall filter =connection-state
6.39
ConnStateExclude
Device.Firewall.X_MIKROTIK_Filter.Chain.{i}.Rule.{i}.ConnStateExclude
W
type: bool , default: "false"
ROS: /ip firewall filter =connection-state
6.39
-
6.39
ChainNumberOfEntries
Device.Firewall.X_MIKROTIK_NAT.ChainNumberOfEntries
-
The number of entries in the Chain table.

type: uint32
6.39
W
Firewall NAT Chain table. Each entry contains an ordered list of Rule objects which can themselves reference other {i}. instances. A hierarchy of rules can therefore be created.

NOTE that there are 2 default/non-editable chains - "dstnat", "srcnat". For Linux knowers they map this way: (dstnat -> PREROUTING, srcnat -> POSTROUTING).
Enable
Device.Firewall.X_MIKROTIK_NAT.Chain.{i}.Enable
W
Enables or disables this Chain. entry.

type: bool , default: "false"
6.39
Name
Device.Firewall.X_MIKROTIK_NAT.Chain.{i}.Name
W
Human-readable name associated with this Chain. entry.

type: string(64)
6.39
RuleNumberOfEntries
Device.Firewall.X_MIKROTIK_NAT.Chain.{i}.RuleNumberOfEntries
-
The number of entries in the Rule table.

type: uint32 , default: "0"
6.39
W
Firewall Rule table.

NOTE that most of Paramaters are similar to standard DM, but multiple of them are extended to have more functionality.


ROS: /ip firewall nat
Enable
Device.Firewall.X_MIKROTIK_NAT.Chain.{i}.Rule.{i}.Enable
W
Enables or disables this Rule. entry.

type: bool , default: "false"
ROS: /ip firewall nat =disabled
6.39
Order
Device.Firewall.X_MIKROTIK_NAT.Chain.{i}.Rule.{i}.Order
W
Position of the Rule. entry in the order of precedence. A value of ''1'' indicates the first entry considered (highest precedence). For each packet, the highest ordered entry that matches the rule criteria is applied. All lower order entries are ignored.

When this value is modified, if the value matches that of an existing entry, the Order value for the existing entry and all lower Order entries is incremented (lowered in precedence) to ensure uniqueness of this value. A deletion causes Order values to be compacted. When a value is changed, incrementing occurs before compaction.

The value of Order on creation of a Rule. table entry MUST be one greater than the largest current value (initially assigned the lowest precedence).

type: uint32[1:]
6.39
Description
Device.Firewall.X_MIKROTIK_NAT.Chain.{i}.Rule.{i}.Description
W
Human-readable description associated with this Rule. entry.

type: string(256)
ROS: /ip firewall nat =comment
6.39
Target
Device.Firewall.X_MIKROTIK_NAT.Chain.{i}.Rule.{i}.Target
W
Action to perform for traffic matching this Rule. entry.

  • Accept ( The firewall accepts packets matching this rule. )
  • Return ( The firewall doesn't consider the remaining rules (if any) in the current chain. )
  • TargetChain ( The rules in the chain referenced by the {{param|TargetChain}} parameter are matched. )
  • Log
  • Passthrough
  • AddSrcToAddressList
  • AddDstToAddressList
  • SourceNAT ( Change src address/port specified in {{param|ToAddresses}} and {{param|ToPorts}}. Can only be used in POSTROUTING. )
  • Masquerade ( Change src address/port determined by routing facility. Can only be used in POSTROUTING. )
  • DestNAT ( Change dst address/port specified in {{param|ToAddresses}} and {{param|ToPorts}}. Can only be used in PREROUTING. )
  • Redirect ( Can only be used in PREROUTING. )
  • Same
  • Netmap

type: enum , default: "Accept"
ROS: /ip firewall nat =action
6.39
TargetChain
Device.Firewall.X_MIKROTIK_NAT.Chain.{i}.Rule.{i}.TargetChain
W
Specifies the chain to process when Target equals TargetChain. If there are no matching rules in the referenced chain, processing continues with the next rule in this chain (if any). In other words, TargetChain behaves like a subroutine call.

empty string indicates no TargetChain is specified.

type: strongRef , default: ""
ROS: /ip firewall nat =jump-target
6.39
Log
Device.Firewall.X_MIKROTIK_NAT.Chain.{i}.Rule.{i}.Log
W
Enable or disable logging, in a ###.DeviceInfo.VendorLogFile, of packets matching this Rule..

type: bool , default: "false"
ROS: /ip firewall nat =log
6.39
SourceInterfaceGroup
Device.Firewall.X_MIKROTIK_NAT.Chain.{i}.Rule.{i}.SourceInterfaceGroup
W
Rule. criterion. Group source interface.

Only one of SourceInterfaceGroup and SourceInterface SHOULD be configured at the same time. If SourceInterface is set, then value of this Parameter will be set to one-interface automatically and if this Parameter is set, then SourceInterface will be set to empty string automatically.

  • one-interface ( {{param|SourceInterface}} is used as the rule criterion. )
  • all
  • all-ethernet
  • all-wireless
  • all-vlan
  • all-ppp

type: enum , default: "all"
ROS: /ip firewall nat =in-interface
6.39
SourceInterface
Device.Firewall.X_MIKROTIK_NAT.Chain.{i}.Rule.{i}.SourceInterface
W
Rule. criterion. This specifies the ingress interface associated with the entry.

Only one of SourceInterfaceGroup and SourceInterface SHOULD be configured at the same time. If SourceInterfaceGroup is set, then value of this Parameter will be set to empty string automatically and if this Parameter is set, then SourceInterfaceGroup will be set to one-interface automatically.

type: strongRef(256) , default: ""
ROS: /ip firewall nat =in-interface
6.39
SourceInterfaceExclude
Device.Firewall.X_MIKROTIK_NAT.Chain.{i}.Rule.{i}.SourceInterfaceExclude
W
If false, the rule matches only those packets that match the SourceInterface or SourceInterfaceGroup entry, if specified.

If true, the rule matches all packets except those that match the SourceInterface or SourceInterfaceGroup entry, if specified.

type: bool , default: "false"
ROS: /ip firewall nat =in-interface
6.39
DestInterfaceGroup
Device.Firewall.X_MIKROTIK_NAT.Chain.{i}.Rule.{i}.DestInterfaceGroup
W
Rule. criterion. Group destination interface.

Only one of DestInterfaceGroup and DestInterface SHOULD be configured at the same time. If DestInterface is set, then value of this Parameter will be set to one-interface automatically and if this Parameter is set, then DestInterface will be set to empty string automatically.

  • one-interface ( {{param|DestInterface}} is used as the rule criterion. )
  • all
  • all-ethernet
  • all-wireless
  • all-vlan
  • all-ppp

type: enum , default: "all"
ROS: /ip firewall nat =out-interface
6.39
DestInterface
Device.Firewall.X_MIKROTIK_NAT.Chain.{i}.Rule.{i}.DestInterface
W
Rule. criterion. This specifies the egress interface associated with the entry.

Only one of DestInterfaceGroup and DestInterface SHOULD be configured at the same time. If DestInterfaceGroup is set, then value of this Parameter will be set to empty string automatically and if this Parameter is set, then DestInterfaceGroup will be set to one-interface automatically.

type: strongRef(256) , default: ""
ROS: /ip firewall nat =out-interface
6.39
DestInterfaceExclude
Device.Firewall.X_MIKROTIK_NAT.Chain.{i}.Rule.{i}.DestInterfaceExclude
W
If false, the rule matches only those packets that match the DestInterface or DestInterfaceGroup entry, if specified.

If true, the rule matches all packets except those that match the DestInterface or DestInterfaceGroup entry, if specified.

type: bool , default: "false"
ROS: /ip firewall nat =out-interface
6.39
DestIPRange
Device.Firewall.X_MIKROTIK_NAT.Chain.{i}.Rule.{i}.DestIPRange
W
Dest IP range.

type: IPv4AddressRange , default: ""
ROS: /ip firewall nat =dst-address
6.39
DestIPExclude
Device.Firewall.X_MIKROTIK_NAT.Chain.{i}.Rule.{i}.DestIPExclude
W
If false, the rule matches only those packets that match the DestIPRange entry, if specified.

If true, the rule matches all packets except those that match the DestIPRange entry, if specified.

type: bool , default: "false"
ROS: /ip firewall nat =dst-address
6.39
SourceIPRange
Device.Firewall.X_MIKROTIK_NAT.Chain.{i}.Rule.{i}.SourceIPRange
W
Source IP range.

type: IPv4AddressRange , default: ""
ROS: /ip firewall nat =src-address
6.39
SourceIPExclude
Device.Firewall.X_MIKROTIK_NAT.Chain.{i}.Rule.{i}.SourceIPExclude
W
If false, the rule matches only those packets that match the SourceIPRange entry, if specified.

If true, the rule matches all packets except those that match the SourceIPRange entry, if specified.

type: bool , default: "false"
ROS: /ip firewall nat =src-address
6.39
Protocol
Device.Firewall.X_MIKROTIK_NAT.Chain.{i}.Rule.{i}.Protocol
W
Rule. criterion.

Protocol number. A value of -1 indicates this criterion is not used for matching.

type: int32[-1:255] , default: "-1"
ROS: /ip firewall nat =protocol
6.39
ProtocolExclude
Device.Firewall.X_MIKROTIK_NAT.Chain.{i}.Rule.{i}.ProtocolExclude
W
If false, the rule matches only those packets that match the Protocol entry, if specified.

If true, the rule matches all packets except those that match the Protocol entry, if specified.

type: bool , default: "false"
ROS: /ip firewall nat =protocol
6.39
DestPortList
Device.Firewall.X_MIKROTIK_NAT.Chain.{i}.Rule.{i}.DestPortList
W
Destination port value. (e.g. - "1", "1-10", "1-10,20-30", "1,20,80,100-200").

type: list<Uint32Range> , default: ""
ROS: /ip firewall nat =dst-port
6.39
DestPortExclude
Device.Firewall.X_MIKROTIK_NAT.Chain.{i}.Rule.{i}.DestPortExclude
W
If false, the rule matches only those packets that match the DestPortList entry, if specified.

If true, the rule matches all packets except those that match the DestPortList, if specified.

type: bool , default: "false"
ROS: /ip firewall nat =dst-port
6.39
SourcePortList
Device.Firewall.X_MIKROTIK_NAT.Chain.{i}.Rule.{i}.SourcePortList
W
Source port value. (e.g. - "1", "1-10", "1-10,20-30", "1,20,80,100-200").

type: list<Uint32Range> , default: ""
ROS: /ip firewall nat =src-port
6.39
SourcePortExclude
Device.Firewall.X_MIKROTIK_NAT.Chain.{i}.Rule.{i}.SourcePortExclude
W
If false, the rule matches only those packets that match the SourcePortList entry, if specified.

If true, the rule matches all packets except those that match the SourcePortList entry, if specified.

type: bool , default: "false"
ROS: /ip firewall nat =src-port
6.39
ToAddresses
Device.Firewall.X_MIKROTIK_NAT.Chain.{i}.Rule.{i}.ToAddresses
W
Replace original address with specified one. Applicable if Target is DestNAT, Netmap, Same, SourceNAT.

type: IPv4AddressRange , default: ""
ROS: /ip firewall nat =to-addresses
6.39
ToPorts
Device.Firewall.X_MIKROTIK_NAT.Chain.{i}.Rule.{i}.ToPorts
W
Replace original port with specified one. Applicable if Target is DestNAT, Netmap, Same, SourceNAT.

type: Uint32Range , default: ""
ROS: /ip firewall nat =to-ports
6.39
-
Contains RouterOS interfaces, which are not applicable to TR069 standard Data Model, but still can be used in TR181-2 InterfaceStack.

6.39
GenericNumberOfEntries
Device.X_MIKROTIK_Interface.GenericNumberOfEntries
-
The number of entries in the Generic table.

type: uint32
6.39
-
Instances of RouterOS /interface objects, whose support hasn't yet been added in tr069-client implementation (e.g. - bridge, ovpn, pptp, vlan).

Also in special cases can contain "invalid/non-exist" instances if RouterOS contains configuration which references invalid interface (e.g. /ip address =interface=*4444), so that valid InterfaceStack can still be represented. These won't have a Name.

Enable
Device.X_MIKROTIK_Interface.Generic.{i}.Enable
-
type: bool
6.39
Status
Device.X_MIKROTIK_Interface.Generic.{i}.Status
-
type: string
6.39
Name
Device.X_MIKROTIK_Interface.Generic.{i}.Name
-
type: string
6.39
LowerLayers
Device.X_MIKROTIK_Interface.Generic.{i}.LowerLayers
-
type: list<strongRef>(1024)
6.39