Manual:TR069-parameters-6.39
Table of Contents
- <a style='color:inherit;' href='#Device.'>Device.</a>
- <a style='color:inherit;' href='#Device.DeviceInfo.'>Device.DeviceInfo.</a>
- <a style='color:inherit;' href='#Device.ManagementServer.'>Device.ManagementServer.</a>
- <a style='color:inherit;' href='#Device.InterfaceStack.'>Device.InterfaceStack.</a>
- <a style='color:inherit;' href='#Device.Cellular.'>Device.Cellular.</a>
- <a style='color:inherit;' href='#Device.Ethernet.'>Device.Ethernet.</a>
- <a style='color:inherit;' href='#Device.WiFi.'>Device.WiFi.</a>
- <a style='color:inherit;' href='#Device.PPP.'>Device.PPP.</a>
- <a style='color:inherit;' href='#Device.IP.'>Device.IP.</a>
- <a style='color:inherit;' href='#Device.Routing.'>Device.Routing.</a>
- <a style='color:inherit;' href='#Device.Hosts.'>Device.Hosts.</a>
- <a style='color:inherit;' href='#Device.DNS.'>Device.DNS.</a>
- <a style='color:inherit;' href='#Device.DHCPv4.'>Device.DHCPv4.</a>
- <a style='color:inherit;' href='#Device.Firewall.'>Device.Firewall.</a>
- <a style='color:inherit;' href='#Device.X_MIKROTIK_Interface.'>Device.X_MIKROTIK_Interface.</a>
Device.RootDataModelVersion
type: string(32)
Device.InterfaceStackNumberOfEntries
type: uint32
Device.DeviceInfo.Manufacturer
type: string(64)
Device.DeviceInfo.ManufacturerOUI
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)
Device.DeviceInfo.ModelName
type: string(64)
, flags: deny-active-notif
Device.DeviceInfo.Description
type: string(256)
, flags: deny-active-notif
Device.DeviceInfo.ProductClass
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)
Device.DeviceInfo.SerialNumber
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)
Device.DeviceInfo.HardwareVersion
type: string(64)
Device.DeviceInfo.SoftwareVersion
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)
Device.DeviceInfo.ProvisioningCode
type: string(64)
Device.DeviceInfo.UpTime
type: uint32
, flags: deny-active-notif
Device.DeviceInfo.VendorConfigFileNumberOfEntries
type: uint32
Device.DeviceInfo.X_MIKROTIK_SystemIdentity
type: string
ROS: /system identity =name
Device.DeviceInfo.X_MIKROTIK_ArchName
type: string
ROS: /system resource =architecture-name
Device.DeviceInfo.VendorConfigFile.{i}.Name
type: string(64)
Device.DeviceInfo.VendorConfigFile.{i}.Description
type: string(256)
Device.DeviceInfo.VendorConfigFile.{i}.UseForBackupRestore
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
Device.DeviceInfo.MemoryStatus.Total
type: uint32
Device.DeviceInfo.MemoryStatus.Free
type: uint32
, flags: deny-active-notif
Device.DeviceInfo.ProcessStatus.CPUUsage
type: uint32[:100]
, flags: deny-active-notif
Device.ManagementServer.URL
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
Device.ManagementServer.Username
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
Device.ManagementServer.Password
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
Device.ManagementServer.PeriodicInformEnable
type: bool
ROS: /tr069-client =periodic-inform-enabled
Device.ManagementServer.PeriodicInformInterval
type: uint32[1:]
ROS: /tr069-client =periodic-inform-interval
Device.ManagementServer.ParameterKey
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
Device.ManagementServer.ConnectionRequestURL
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)
Device.ManagementServer.ConnectionRequestUsername
type: string(256)
ROS: /tr069-client =connection-request-username
Device.ManagementServer.ConnectionRequestPassword
type: string(256)
, flags: hidden
ROS: /tr069-client =connection-request-password
Device.ManagementServer.AliasBasedAddressing
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
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.
Device.InterfaceStack.{i}.HigherLayer
When the referenced higher layer interface is deleted, the CPE MUST delete the table row.
type: strongRef(256)
Device.InterfaceStack.{i}.LowerLayer
When the referenced lower layer interface is deleted, the CPE MUST delete the table row.
type: strongRef(256)
Device.Cellular.InterfaceNumberOfEntries
type: uint32
Device.Cellular.AccessPointNumberOfEntries
type: uint32
ROS: /interface lte
Device.Cellular.Interface.{i}.Enable
This parameter is based on ifAdminStatus from [RFC2863].
type: bool
ROS: /interface lte =disabled
Device.Cellular.Interface.{i}.Status
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 Template:Enum, Template:Enum, Template:Enum etc ATTACHED status
) - Down
- Unknown
- Dormant
- NotPresent ( Corresponds to Template:Enum, Template:Enum, Template:Enum etc DETACHED status )
- LowerLayerDown
- Error
type: enum
, flags: deny-active-notif
Device.Cellular.Interface.{i}.LowerLayers
Note: Since Interface. is a layer 1 interface, it is expected that LowerLayers will not be used.
type: list<strongRef>(1024)
Device.Cellular.Interface.{i}.IMEI
type: string(15:15)
Device.Cellular.Interface.{i}.RSSI
type: int32
, flags: deny-active-notif
Device.Cellular.Interface.{i}.X_MIKROTIK_SINR
type: int32
, flags: deny-active-notif
Device.Cellular.Interface.{i}.X_MIKROTIK_RSRP
type: int32
, flags: deny-active-notif
Device.Cellular.Interface.{i}.X_MIKROTIK_RSRQ
type: int32
, flags: deny-active-notif
Device.Cellular.Interface.{i}.X_MIKROTIK_CellId
type: uint32
Device.Cellular.Interface.{i}.X_MIKROTIK_BandInfo
type: string
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 #.Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface's #.Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [TR-181i2].
Device.Cellular.Interface.{i}.Stats.BytesSent
type: StatsCounter64
, flags: deny-active-notif
Device.Cellular.Interface.{i}.Stats.BytesReceived
type: StatsCounter64
, flags: deny-active-notif
Device.Cellular.Interface.{i}.Stats.PacketsSent
type: StatsCounter64
, flags: deny-active-notif
Device.Cellular.Interface.{i}.Stats.PacketsReceived
type: StatsCounter64
, flags: deny-active-notif
Device.Cellular.Interface.{i}.Stats.ErrorsSent
type: StatsCounter64
, flags: deny-active-notif
Device.Cellular.Interface.{i}.Stats.ErrorsReceived
type: StatsCounter64
, flags: deny-active-notif
Device.Cellular.Interface.{i}.Stats.DiscardPacketsSent
type: StatsCounter64
, flags: deny-active-notif
Device.Cellular.Interface.{i}.Stats.DiscardPacketsReceived
type: StatsCounter64
, flags: deny-active-notif
Device.Cellular.AccessPoint.{i}.APN
type: string(64)
Device.Cellular.AccessPoint.{i}.Username
type: string(256)
Device.Cellular.AccessPoint.{i}.Password
type: string(256)
, flags: hidden
Device.Cellular.AccessPoint.{i}.Interface
type: strongRef
NOTE that VLANTermination object is not supported yet.
Device.Ethernet.InterfaceNumberOfEntries
type: uint32
Device.Ethernet.LinkNumberOfEntries
type: uint32
ROS: /interface ethernet
Device.Ethernet.Interface.{i}.Enable
This parameter is based on ifAdminStatus from [RFC2863].
type: bool
ROS: /interface ethernet =disabled
Device.Ethernet.Interface.{i}.Status
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
Device.Ethernet.Interface.{i}.LowerLayers
Note: Since Interface. is a layer 1 interface, it is expected that LowerLayers will not be used.
type: list<strongRef>(1024)
Device.Ethernet.Interface.{i}.MACAddress
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 .Ethernet.Link.{i}.MACAddress parameter.
type: MACAddress
ROS: /interface ethernet =orig-mac-address
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 #.Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface's #.Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [TR-181i2].
Device.Ethernet.Interface.{i}.Stats.BytesSent
type: uint64
, flags: deny-active-notif
Device.Ethernet.Interface.{i}.Stats.BytesReceived
type: uint64
, flags: deny-active-notif
Device.Ethernet.Interface.{i}.Stats.PacketsSent
type: uint64
, flags: deny-active-notif
Device.Ethernet.Interface.{i}.Stats.PacketsReceived
type: uint64
, flags: deny-active-notif
Device.Ethernet.Interface.{i}.Stats.ErrorsSent
type: uint32
, flags: deny-active-notif
Device.Ethernet.Interface.{i}.Stats.ErrorsReceived
type: uint32
, flags: deny-active-notif
Device.Ethernet.Interface.{i}.Stats.DiscardPacketsSent
type: uint32
, flags: deny-active-notif
Device.Ethernet.Interface.{i}.Stats.DiscardPacketsReceived
type: uint32
, flags: deny-active-notif
Device.Ethernet.Link.{i}.Enable
This parameter is based on ifAdminStatus from [RFC2863].
type: bool
, default: "false"
Device.Ethernet.Link.{i}.Status
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"
Device.Ethernet.Link.{i}.LowerLayers
type: list<strongRef>(1024)
, default: ""
NOTE that EndPoint object is not supported yet.
Device.WiFi.RadioNumberOfEntries
type: uint32
Device.WiFi.SSIDNumberOfEntries
type: uint32
Device.WiFi.AccessPointNumberOfEntries
type: uint32
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
Device.WiFi.Radio.{i}.Enable
This parameter is based on ifAdminStatus from [RFC2863].
type: bool
ROS: /interface wireless =disabled
Device.WiFi.Radio.{i}.Status
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
Device.WiFi.Radio.{i}.LowerLayers
Note: Since Radio. is a layer 1 interface, it is expected that LowerLayers will not be used.
type: list<strongRef>(1024)
Device.WiFi.Radio.{i}.SupportedFrequencyBands
- 2.4GHz
- 5GHz
type: list<enum>
Device.WiFi.Radio.{i}.OperatingFrequencyBand
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
Device.WiFi.Radio.{i}.SupportedStandards
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 (
Template:Bibref
) - b ( Template:Bibref )
- g ( Template:Bibref )
- n ( Template:Bibref )
- ac ( Template:Bibref )
type: list<enum>
Device.WiFi.Radio.{i}.OperatingStandards
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
Device.WiFi.Radio.{i}.PossibleChannels
Ranges in the form "n-m" are permitted.
For example, for 802.11b and North America, would be "1-11".
type: list<string>(1024)
Device.WiFi.Radio.{i}.Channel
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
Device.WiFi.Radio.{i}.AutoChannelSupported
type: bool
Device.WiFi.Radio.{i}.AutoChannelEnable
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
Device.WiFi.NeighboringWiFiDiagnostic.DiagnosticsState
- None
- Requested
- Canceled
- Complete
- Error
- Completed
type: DiagnosticsState
Device.WiFi.NeighboringWiFiDiagnostic.ResultNumberOfEntries
type: uint32
Device.WiFi.NeighboringWiFiDiagnostic.Result.{i}.Radio
type: strongRef
Device.WiFi.NeighboringWiFiDiagnostic.Result.{i}.SSID
type: string(32)
Device.WiFi.NeighboringWiFiDiagnostic.Result.{i}.BSSID
type: MACAddress
Device.WiFi.NeighboringWiFiDiagnostic.Result.{i}.Channel
type: uint32[1:255]
Device.WiFi.NeighboringWiFiDiagnostic.Result.{i}.SignalStrength
type: int32[-200:]
Device.WiFi.NeighboringWiFiDiagnostic.Result.{i}.OperatingFrequencyBand
- 2.4GHz
- 5GHz
type: enum
Device.WiFi.NeighboringWiFiDiagnostic.Result.{i}.OperatingStandards
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>
Device.WiFi.NeighboringWiFiDiagnostic.Result.{i}.OperatingChannelBandwidth
- 20MHz
- 40MHz
- 80MHz
type: enum
Device.WiFi.NeighboringWiFiDiagnostic.Result.{i}.Noise
type: int32[-200:]
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
Device.WiFi.SSID.{i}.Enable
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 disabled all related SSIDs.
type: bool
, default: "false"
ROS: /interface wireless =disabled
Device.WiFi.SSID.{i}.Status
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"
Device.WiFi.SSID.{i}.LowerLayers
type: list<strongRef>(1024)
, default: ""
Device.WiFi.SSID.{i}.BSSID
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
Device.WiFi.SSID.{i}.MACAddress
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 .Ethernet.Link.{i}.MACAddress parameter.
type: MACAddress
ROS: /interface wireless =mac-address
Device.WiFi.SSID.{i}.SSID
type: string(32)
ROS: /interface wireless =ssid
Device.WiFi.SSID.{i}.Stats.BytesSent
type: uint64
, flags: deny-active-notif
Device.WiFi.SSID.{i}.Stats.BytesReceived
type: uint64
, flags: deny-active-notif
Device.WiFi.SSID.{i}.Stats.PacketsSent
type: uint64
, flags: deny-active-notif
Device.WiFi.SSID.{i}.Stats.PacketsReceived
type: uint64
, flags: deny-active-notif
Device.WiFi.SSID.{i}.Stats.ErrorsSent
type: uint32
Device.WiFi.SSID.{i}.Stats.ErrorsReceived
type: uint32
, flags: deny-active-notif
Device.WiFi.SSID.{i}.Stats.DiscardPacketsSent
type: uint32
, flags: deny-active-notif
Device.WiFi.SSID.{i}.Stats.DiscardPacketsReceived
type: uint32
, flags: deny-active-notif
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.
Device.WiFi.AccessPoint.{i}.Enable
type: bool
, default: "false"
Device.WiFi.AccessPoint.{i}.Status
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"
Device.WiFi.AccessPoint.{i}.SSIDReference
type: strongRef(256)
, default: ""
Device.WiFi.AccessPoint.{i}.SSIDAdvertisementEnabled
type: bool
, default: "true"
Device.WiFi.AccessPoint.{i}.AssociatedDeviceNumberOfEntries
type: uint32
, default: "0"
Device.WiFi.AccessPoint.{i}.Security.ModesSupported
- 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"
Device.WiFi.AccessPoint.{i}.Security.ModeEnabled
type: string
, default: "None"
Device.WiFi.AccessPoint.{i}.Security.KeyPassphrase
type: string(8:63)
, flags: hidden
Device.WiFi.AccessPoint.{i}.AssociatedDevice.{i}.MACAddress
type: MACAddress
, flags: deny-active-notif
Device.WiFi.AccessPoint.{i}.AssociatedDevice.{i}.AuthenticationState
type: bool
, flags: deny-active-notif
Device.WiFi.AccessPoint.{i}.AssociatedDevice.{i}.SignalStrength
type: int32[-200:]
The CPE MUST reset these Stats. parameters (unless otherwise stated in individual object or parameter descriptions) either when the ##.Status of the parent ## object transitions from Disabled to Enabled, or when it transitions from Enabled to Disabled.
Device.WiFi.AccessPoint.{i}.AssociatedDevice.{i}.Stats.BytesSent
type: StatsCounter64
Device.WiFi.AccessPoint.{i}.AssociatedDevice.{i}.Stats.BytesReceived
type: StatsCounter64
Device.WiFi.AccessPoint.{i}.AssociatedDevice.{i}.Stats.PacketsSent
type: StatsCounter64
Device.WiFi.AccessPoint.{i}.AssociatedDevice.{i}.Stats.PacketsReceived
type: StatsCounter64
Device.PPP.InterfaceNumberOfEntries
type: uint32
NOTE that Parameters can be changed only when X_MIKROTIK_Type is configured.
Device.PPP.Interface.{i}.Enable
This parameter is based on ifAdminStatus from [RFC2863].
type: bool
, default: "false"
Device.PPP.Interface.{i}.Status
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"
Device.PPP.Interface.{i}.LowerLayers
type: list<strongRef>(1024)
, default: ""
Device.PPP.Interface.{i}.ConnectionStatus
- Unconfigured
- Connecting
- Authenticating
- Connected
- PendingDisconnect
- Disconnecting
- Disconnected
type: enum
, default: "Unconfigured"
Device.PPP.Interface.{i}.AutoDisconnectTime
type: uint32
, default: "0"
Device.PPP.Interface.{i}.IdleDisconnectTime
type: uint32
, default: "0"
Device.PPP.Interface.{i}.Username
type: string(64)
Device.PPP.Interface.{i}.Password
type: string(64)
, flags: hidden
Device.PPP.Interface.{i}.EncryptionProtocol
- None
- MPPE
type: enum
Device.PPP.Interface.{i}.ConnectionTrigger
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"
Device.PPP.Interface.{i}.X_MIKROTIK_Type
- PPPoE
type: enum
, default: ""
Device.PPP.Interface.{i}.PPPoE.ACName
type: string(256)
Device.PPP.Interface.{i}.PPPoE.ServiceName
type: string(256)
Device.PPP.Interface.{i}.IPCP.LocalIPAddress
type: IPv4Address
, default: ""
Device.PPP.Interface.{i}.IPCP.RemoteIPAddress
type: IPv4Address
, default: ""
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 #.Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface's #.Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [TR-181i2].
Device.PPP.Interface.{i}.Stats.BytesSent
type: uint64
, flags: deny-active-notif
Device.PPP.Interface.{i}.Stats.BytesReceived
type: uint64
, flags: deny-active-notif
Device.PPP.Interface.{i}.Stats.PacketsSent
type: uint64
, flags: deny-active-notif
Device.PPP.Interface.{i}.Stats.PacketsReceived
type: uint64
, flags: deny-active-notif
Device.PPP.Interface.{i}.Stats.ErrorsSent
type: uint32
, flags: deny-active-notif
Device.PPP.Interface.{i}.Stats.ErrorsReceived
type: uint32
, flags: deny-active-notif
Device.PPP.Interface.{i}.Stats.DiscardPacketsSent
type: uint32
, flags: deny-active-notif
Device.PPP.Interface.{i}.Stats.DiscardPacketsReceived
type: uint32
, flags: deny-active-notif
Device.IP.InterfaceNumberOfEntries
type: uint32
Device.IP.Interface.{i}.Enable
This parameter is based on ifAdminStatus from [RFC2863].
type: bool
, default: "false"
Device.IP.Interface.{i}.Status
This parameter is based on ifOperStatus from [RFC2863].
- Up
- Down
- Unknown
- Dormant
- NotPresent
- LowerLayerDown
- Error
type: enum
, default: "Down"
Device.IP.Interface.{i}.LowerLayers
type: list<strongRef>(1024)
, default: ""
Device.IP.Interface.{i}.IPv4AddressNumberOfEntries
type: uint32
, default: "0"
ROS: /ip address
Device.IP.Interface.{i}.IPv4Address.{i}.Enable
type: bool
, default: "false"
ROS: /ip address =disabled
Device.IP.Interface.{i}.IPv4Address.{i}.Status
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"
Device.IP.Interface.{i}.IPv4Address.{i}.IPAddress
This parameter can only be modified if the AddressingType is Static.
type: IPv4Address
, default: "255.255.255.255"
ROS: /ip address =address
Device.IP.Interface.{i}.IPv4Address.{i}.SubnetMask
This parameter can only be modified if the AddressingType is Static.
type: IPv4Address
, default: "255.255.255.255"
ROS: /ip address =address
Device.IP.Interface.{i}.IPv4Address.{i}.AddressingType
- Static
- X_MIKROTIK_Dynamic
type: enum
, default: "Static"
Device.IP.Diagnostics.IPPing.DiagnosticsState
- 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
Device.IP.Diagnostics.IPPing.Interface
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)
Device.IP.Diagnostics.IPPing.Host
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)
Device.IP.Diagnostics.IPPing.NumberOfRepetitions
type: uint32[1:]
Device.IP.Diagnostics.IPPing.Timeout
type: uint32[1:]
Device.IP.Diagnostics.IPPing.DataBlockSize
type: uint32[1:65535]
Device.IP.Diagnostics.IPPing.DSCP
type: uint32[:63]
Device.IP.Diagnostics.IPPing.SuccessCount
type: uint32
, flags: deny-active-notif
Device.IP.Diagnostics.IPPing.FailureCount
type: uint32
, flags: deny-active-notif
Device.IP.Diagnostics.IPPing.AverageResponseTime
type: uint32
, flags: deny-active-notif
Device.IP.Diagnostics.IPPing.MinimumResponseTime
type: uint32
, flags: deny-active-notif
Device.IP.Diagnostics.IPPing.MaximumResponseTime
type: uint32
, flags: deny-active-notif
Device.IP.Diagnostics.IPPing.AverageResponseTimeDetailed
type: uint32
, flags: deny-active-notif
Device.IP.Diagnostics.IPPing.MinimumResponseTimeDetailed
type: uint32
, flags: deny-active-notif
Device.IP.Diagnostics.IPPing.MaximumResponseTimeDetailed
type: uint32
, flags: deny-active-notif
Device.IP.Diagnostics.TraceRoute.DiagnosticsState
- 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
Device.IP.Diagnostics.TraceRoute.Interface
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)
Device.IP.Diagnostics.TraceRoute.Host
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)
Device.IP.Diagnostics.TraceRoute.NumberOfTries
type: uint32[1:3]
Device.IP.Diagnostics.TraceRoute.Timeout
type: uint32[1:]
Device.IP.Diagnostics.TraceRoute.DataBlockSize
type: uint32[1:65535]
Device.IP.Diagnostics.TraceRoute.DSCP
type: uint32[:63]
Device.IP.Diagnostics.TraceRoute.MaxHopCount
type: uint32[1:64]
Device.IP.Diagnostics.TraceRoute.ResponseTime
type: uint32
, flags: deny-active-notif
Device.IP.Diagnostics.TraceRoute.RouteHopsNumberOfEntries
type: uint32
, flags: deny-active-notif
Device.IP.Diagnostics.TraceRoute.RouteHops.{i}.Host
type: string(256)
, flags: deny-active-notif
Device.IP.Diagnostics.TraceRoute.RouteHops.{i}.HostAddress
type: string
, flags: deny-active-notif
Device.IP.Diagnostics.TraceRoute.RouteHops.{i}.ErrorCode
type: uint32
, flags: deny-active-notif
Device.IP.Diagnostics.TraceRoute.RouteHops.{i}.RTTimes
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 #.RouteHopsNumberOfEntries parameter.
type: list<uint32>(16)
Device.Routing.RouterNumberOfEntries
type: uint32
Current implementation will contain 1 read-only Router object.
Device.Routing.Router.{i}.Enable
type: bool
, default: "false"
Device.Routing.Router.{i}.Status
- Disabled
- Enabled
- Error
type: enum
, default: "Disabled"
Device.Routing.Router.{i}.IPv4ForwardingNumberOfEntries
type: uint32
, default: "0"
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
Device.Routing.Router.{i}.IPv4Forwarding.{i}.Enable
type: bool
, default: "false"
ROS: /ip route =disabled
Device.Routing.Router.{i}.IPv4Forwarding.{i}.Status
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"
Device.Routing.Router.{i}.IPv4Forwarding.{i}.StaticRoute
type: bool
, default: "true"
Device.Routing.Router.{i}.IPv4Forwarding.{i}.DestIPAddress
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
Device.Routing.Router.{i}.IPv4Forwarding.{i}.DestSubnetMask
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
Device.Routing.Router.{i}.IPv4Forwarding.{i}.GatewayIPAddress
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
Device.Routing.Router.{i}.IPv4Forwarding.{i}.Interface
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
Device.Routing.Router.{i}.IPv4Forwarding.{i}.Origin
- 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"
Device.Hosts.HostNumberOfEntries
type: uint32
Device.Hosts.Host.{i}.PhysAddress
type: string(64)
Device.Hosts.Host.{i}.IPAddress
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
Device.Hosts.Host.{i}.DHCPClient
type: list<strongRef>
Device.Hosts.Host.{i}.AssociatedDevice
For example: Device.WiFi.AccessPoint.1.AssociatedDevice.2
type: strongRef(256)
Device.Hosts.Host.{i}.Layer1Interface
For example: Device.Ethernet.Interface.2
type: strongRef(256)
Device.Hosts.Host.{i}.Layer3Interface
type: strongRef(256)
Device.Hosts.Host.{i}.HostName
type: string(64)
Device.DNS.Client.ServerNumberOfEntries
type: uint32
Device.DNS.Client.Server.{i}.Enable
type: bool
, default: "false"
Device.DNS.Client.Server.{i}.Status
The Error value MAY be used by the CPE to indicate a locally defined error condition.
- Disabled
- Enabled
- Error
type: enum
, default: "Disabled"
Device.DNS.Client.Server.{i}.DNSServer
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
Device.DNS.Client.Server.{i}.Type
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"
Device.DHCPv4.ClientNumberOfEntries
type: uint32
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
Device.DHCPv4.Client.{i}.Enable
type: bool
, default: "false"
ROS: /ip dhcp-client =disabled
Device.DHCPv4.Client.{i}.Interface
type: strongRef(256)
, default: ""
ROS: /ip dhcp-client =interface
Device.DHCPv4.Client.{i}.Status
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"
Device.DHCPv4.Client.{i}.DHCPStatus
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
Device.DHCPv4.Client.{i}.IPAddress
type: IPv4Address
, default: ""
Device.DHCPv4.Client.{i}.SubnetMask
Value is information received via DHCP Option 1.
type: IPv4Address
, default: ""
Device.DHCPv4.Client.{i}.IPRouters
Value is information received via DHCP Options 3, 33 or 121.
type: list<IPv4Address>(256)
, default: ""
Device.DHCPv4.Client.{i}.DNSServers
Value is information received via DHCP Option 6.
type: list<IPv4Address>(256)
, default: ""
Device.DHCPv4.Client.{i}.DHCPServer
type: IPv4Address
, default: ""
Device.DHCPv4.Server.PoolNumberOfEntries
type: uint32
Each instance maps to "/ip dhcp-server" record and manages respective "/ip dhcp-server network" automatically.
ROS: /ip dhcp-server
Device.DHCPv4.Server.Pool.{i}.Enable
type: bool
, default: "false"
ROS: /ip dhcp-server =disabled
Device.DHCPv4.Server.Pool.{i}.Status
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"
Device.DHCPv4.Server.Pool.{i}.Interface
type: strongRef(256)
, default: ""
ROS: /ip dhcp-server =interface
Device.DHCPv4.Server.Pool.{i}.MinAddress
Must be set together with MaxAddress.
type: IPv4Address
ROS: /ip pool =ranges
Device.DHCPv4.Server.Pool.{i}.MaxAddress
Must be set together with MinAddress.
type: IPv4Address
ROS: /ip pool =ranges
Device.DHCPv4.Server.Pool.{i}.SubnetMask
MinAddress and MaxAddress must be set.
type: IPv4Address
ROS: /ip dhcp-server network =address
Device.DHCPv4.Server.Pool.{i}.DNSServers
MinAddress, MaxAddress and SubnetMask must be set.
type: list<IPv4Address>
ROS: /ip dhcp-server network =dns-server
Device.DHCPv4.Server.Pool.{i}.DomainName
MinAddress, MaxAddress and SubnetMask must be set.
type: string(64)
ROS: /ip dhcp-server network =domain
Device.DHCPv4.Server.Pool.{i}.IPRouters
MinAddress, MaxAddress and SubnetMask must be set.
type: list<IPv4Address>
ROS: /ip dhcp-server network =gateway
Device.DHCPv4.Server.Pool.{i}.LeaseTime
type: int32[1:]
, default: "86400"
ROS: /ip dhcp-server =lease-time
Device.DHCPv4.Server.Pool.{i}.StaticAddressNumberOfEntries
type: uint32
, default: "0"
Device.DHCPv4.Server.Pool.{i}.ClientNumberOfEntries
type: uint32
, default: "0"
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
Device.DHCPv4.Server.Pool.{i}.StaticAddress.{i}.Enable
Disabling an entry does not return the IP address to the pool.
type: bool
, default: "false"
ROS: /ip dhcp-server lease =disabled
Device.DHCPv4.Server.Pool.{i}.StaticAddress.{i}.Chaddr
type: MACAddress
, default: ""
ROS: /ip dhcp-server lease =address
Device.DHCPv4.Server.Pool.{i}.StaticAddress.{i}.Yiaddr
type: IPv4Address
, default: ""
ROS: /ip dhcp-server lease =max-address
This table lists details of DHCPv4 clients that matched the filter criteria of this # entry.
Device.DHCPv4.Server.Pool.{i}.Client.{i}.Chaddr
type: MACAddress
Device.DHCPv4.Server.Pool.{i}.Client.{i}.IPv4AddressNumberOfEntries
type: uint32
, default: "0"
Device.DHCPv4.Server.Pool.{i}.Client.{i}.IPv4Address.{i}.IPAddress
type: IPv4Address
Device.DHCPv4.Server.Pool.{i}.Client.{i}.IPv4Address.{i}.LeaseTimeRemaining
type: UNKNOWN
Device.Firewall.X_MIKROTIK_Filter.ChainNumberOfEntries
NOTE that there are 3 default/non-editable chains - "forward", "input", "output"
Device.Firewall.X_MIKROTIK_Filter.Chain.{i}.Enable
type: bool
, default: "false"
Device.Firewall.X_MIKROTIK_Filter.Chain.{i}.Name
type: string(64)
Device.Firewall.X_MIKROTIK_Filter.Chain.{i}.RuleNumberOfEntries
type: uint32
, default: "0"
NOTE that most of Paramaters are similar to standard DM, but multiple of them are extended to have more functionality.
ROS: /ip firewall filter
Device.Firewall.X_MIKROTIK_Filter.Chain.{i}.Rule.{i}.Enable
type: bool
, default: "false"
ROS: /ip firewall filter =disabled
Device.Firewall.X_MIKROTIK_Filter.Chain.{i}.Rule.{i}.Order
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:]
Device.Firewall.X_MIKROTIK_Filter.Chain.{i}.Rule.{i}.Description
type: string(256)
ROS: /ip firewall filter =comment
Device.Firewall.X_MIKROTIK_Filter.Chain.{i}.Rule.{i}.Target
- 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 Template:Param parameter are matched. )
- Log
- Passthrough
- AddSrcToAddressList
- AddDstToAddressList
- Tarpit
- FasttrackConnection
type: enum
, default: "Drop"
ROS: /ip firewall filter =action
Device.Firewall.X_MIKROTIK_Filter.Chain.{i}.Rule.{i}.TargetChain
empty string indicates no TargetChain is specified.
type: strongRef
, default: ""
ROS: /ip firewall filter =jump-target
Device.Firewall.X_MIKROTIK_Filter.Chain.{i}.Rule.{i}.Log
type: bool
, default: "false"
ROS: /ip firewall filter =log
Device.Firewall.X_MIKROTIK_Filter.Chain.{i}.Rule.{i}.SourceInterfaceGroup
- all-ethernet
- all-wireless
- all-vlan
- all-ppp
type: enum
, default: ""
ROS: /ip firewall filter =in-interface
Device.Firewall.X_MIKROTIK_Filter.Chain.{i}.Rule.{i}.SourceInterface
This specifies the ingress interface associated with the entry.
type: strongRef(256)
, default: ""
ROS: /ip firewall filter =in-interface
Device.Firewall.X_MIKROTIK_Filter.Chain.{i}.Rule.{i}.SourceInterfaceExclude
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
Device.Firewall.X_MIKROTIK_Filter.Chain.{i}.Rule.{i}.SourceAllInterfaces
type: bool
, default: "true"
ROS: /ip firewall filter =in-interface
Device.Firewall.X_MIKROTIK_Filter.Chain.{i}.Rule.{i}.DestInterfaceGroup
- all-ethernet
- all-wireless
- all-vlan
- all-ppp
type: enum
, default: ""
ROS: /ip firewall filter =out-interface
Device.Firewall.X_MIKROTIK_Filter.Chain.{i}.Rule.{i}.DestInterface
This specifies the egress interface associated with the entry.
type: strongRef(256)
, default: ""
ROS: /ip firewall filter =out-interface
Device.Firewall.X_MIKROTIK_Filter.Chain.{i}.Rule.{i}.DestInterfaceExclude
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
Device.Firewall.X_MIKROTIK_Filter.Chain.{i}.Rule.{i}.DestAllInterfaces
This parameter can only be modified if the Rule. is Static (as explained in the object description).
type: bool
, default: "true"
ROS: /ip firewall filter =out-interface
Device.Firewall.X_MIKROTIK_Filter.Chain.{i}.Rule.{i}.DestIPRange
type: IPv4AddressRange
, default: ""
ROS: /ip firewall filter =dst-address
Device.Firewall.X_MIKROTIK_Filter.Chain.{i}.Rule.{i}.DestIPExclude
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
Device.Firewall.X_MIKROTIK_Filter.Chain.{i}.Rule.{i}.SourceIPRange
type: IPv4AddressRange
, default: ""
ROS: /ip firewall filter =src-address
Device.Firewall.X_MIKROTIK_Filter.Chain.{i}.Rule.{i}.SourceIPExclude
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
Device.Firewall.X_MIKROTIK_Filter.Chain.{i}.Rule.{i}.Protocol
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
Device.Firewall.X_MIKROTIK_Filter.Chain.{i}.Rule.{i}.ProtocolExclude
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
Device.Firewall.X_MIKROTIK_Filter.Chain.{i}.Rule.{i}.DestPortList
type: list<Uint32Range>
, default: ""
ROS: /ip firewall filter =dst-port
Device.Firewall.X_MIKROTIK_Filter.Chain.{i}.Rule.{i}.DestPortExclude
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
Device.Firewall.X_MIKROTIK_Filter.Chain.{i}.Rule.{i}.SourcePortList
type: list<Uint32Range>
, default: ""
ROS: /ip firewall filter =src-port
Device.Firewall.X_MIKROTIK_Filter.Chain.{i}.Rule.{i}.SourcePortExclude
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
Device.Firewall.X_MIKROTIK_Filter.Chain.{i}.Rule.{i}.ConnState
- Established
- Invalid
- New
- Related
- Untracked
type: list<enum>
, default: ""
ROS: /ip firewall filter =connection-state
Device.Firewall.X_MIKROTIK_Filter.Chain.{i}.Rule.{i}.ConnStateExclude
, default: "false"
ROS: /ip firewall filter =connection-state
Device.X_MIKROTIK_Interface.GenericNumberOfEntries
type: uint32
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.
Device.X_MIKROTIK_Interface.Generic.{i}.Enable
Device.X_MIKROTIK_Interface.Generic.{i}.Status
Device.X_MIKROTIK_Interface.Generic.{i}.Name
Device.X_MIKROTIK_Interface.Generic.{i}.LowerLayers