action (accept | add-dst-to-address-list | ...; Default: accept) | Action to take if a packet is matched by the rule:accept - Accept the packet. It is not passed to the next firewall rule.add-dst-to-address-list - Add the destination address to the address list specified by address-list parameteradd-src-to-address-list - Add source address to the address list specified by address-list parameterdrop -Silently drop the packet.jump - Jump to the user-defined chain specified by the value of jump-target a parameterlog - Add a message to the system log containing the following data: in-interface, out-interface, src-mac, protocol, src-ip:port->dst-ip:port and length of the packet. After a packet is matched it is passed to the next rule in the list, similar to passthrough passthrough - Ignore this rule and go to the next one (useful for statistics).reject - Drop the packet and send an ICMP reject messagereturn - Passes control back to the chain from where the jump took place.
|
address-list-timeout (none-dynamic | none-static | time; Default: none-dynamic) | Time interval after which the address will be removed from the address list specified by address-list parameter. Used in conjunction with add-dst-to-address-list or add-src-to-address-list actions
- Value of none-dynamic (
00:00:00 ) will leave the address in the address list till reboot - Value of none-static will leave the address in the address list forever and will be included in the configuration export/backup
|
chain (name; Default: ) | Specifies to which chain rule will be added. If the input does not match the name of an already defined chain, a new chain will be created |
comment (string; Default: ) | Descriptive comment for the rule |
connection-bytes (integer-integer; Default: ) | Matches packets only if a given amount of bytes has been transferred through the particular connection. 0 - means infinity, for example connection-bytes=2000000-0 means that the rule matches if more than 2MB has been transferred through the relevant connection |
connection-limit (integer,netmask; Default: ) | Matches connections per address or address block after a given value is reached. Should be used together with connection-state=new and/or with tcp-flags=syn because matcher is very resource-intensive |
connection-mark (no-mark | string; Default: ) | Matches packets marked via mangle facility with particular connection mark. If no-mark is set, the rule will match any unmarked connection |
connection-rate (Integer 0..4294967295; Default: ) | Connection Rate is a firewall matcher that allows capturing traffic based on the present speed of the connection |
connection-state (established | invalid | new | related | untracked; Default: ) | Interprets the connection tracking analytics data for a particular packet:established - a packet that belongs to an existing connectioninvalid - a packet that does not have a determined state in connection tracking (usually - severe out-of-order packets, packets with wrong sequence/ack number, or in case of a resource over usage on the router), for this reason, an invalid packet will not participate in NAT (as only connection-state=new packets do), and will still contain original source IP address when routed. We strongly suggest dropping all connection-state=invalid packets in the firewall filter forward and input chainsnew - the packet has started a new connection, or is otherwise associated with a connection that has not seen packets in both directions.related - a packet that is related to, but not parts of an existing connection, such as ICMP errors or a packet that begins an FTP data connectionuntracked - a packet that was set to bypass connection tracking in firewall RAW tables.
|
connection-type (ftp | h323 | irc | pptp | quake3 | sip | tftp; Default: ) | Matches packets from related connections based on information from their connection tracking helpers. A relevant connection helper must be enabled under the: /ip firewall service-port |
content (string; Default: ) | Match packets that contain specified text |
dscp (integer: 0..63; Default: ) | Matches DSCP IP header field. |
dst-address (IP/netmask | IP range; Default: ) | Matches packets whose destination is equal to a specified IP or falls into a specified IP range. |
dst-address-list (name; Default: ) | Matches the destination address of a packet against a user-defined address list. |
dst-address-type (unicast | local | broadcast | multicast; Default: ) | Matches destination address type:unicast - IP address used for point-to-point transmissionlocal - if dst-address is assigned to one of the router's interfacesbroadcast - packet is sent to all devices in a subnetmulticast - packet is forwarded to a defined group of devices
|
dst-limit (integer[/time],integer,dst-address | dst-port | src-address[/time]; Default: ) | Matches packets until a given rate is exceeded. Rate is defined as packets per time interval. As opposed to the limit matcher, every flow has its own limit. Flow is defined by a mode parameter. Parameters are written in the following format: rate[/time],burst,mode[/expire] .- rate - packet count per time interval per-flow to match
- time - specifies the time interval in which the packet count rate per flow cannot be exceeded (optional, 1s will be used if not specified)
- burst - initial number of packets per flow to match: this number gets recharged by one every
time /rate , up to this number - mode - this parameter specifies what unique fields define flow (src-address, dst-address, src-and-dst-address, dst-address-and-port, addresses-and-dst-port)
- expire - specifies interval after which flow with no packets will be allowed to be deleted (optional)
|
dst-port (integer[-integer]: 0..65535; Default: ) | List of destination port numbers or port number ranges |
icmp-options (integer:integer; Default: ) | Matches ICMP type: code fields |
in-bridge-port (name; Default: ) | Actual interface the packet has entered the router if the incoming interface is a bridge. Works only if use-ip-firewall is enabled in bridge settings. |
in-bridge-port-list (name; Default: ) | Set of interfaces defined in interface list. Works the same as in-bridge-port |
in-interface (name; Default: ) | Interface the packet has entered the router |
in-interface-list (name; Default: ) | Set of interfaces defined in interface list. Works the same as in-interface |
ingress-priority (integer: 0..63; Default: ) | Matches the priority of an ingress packet. Priority may be derived from VLAN, WMM, DSCP, or MPLS EXP bit. |
ipsec-policy (in | out, ipsec | none; Default: ) | Matches the policy used by IPsec. Value is written in the following format: direction, policy . The direction is Used to select whether to match the policy used for decapsulation or the policy that will be used for encapsulation.in - valid in the PREROUTING, INPUT, and FORWARD chainsout - valid in the POSTROUTING, OUTPUT, and FORWARD chains
ipsec - matches if the packet is subject to IPsec processing;none - matches packet that is not subject to IPsec processing (for example, IPSec transport packet).
For example, if a router receives an IPsec encapsulated Gre packet, then rule ipsec-policy=in,ipsec will match Gre packet, but a rule ipsec-policy=in,none will match the ESP packet. |
jump-target (name; Default: ) | Name of the target chain to jump to. Applicable only if action=jump |
limit (integer,time,integer; Default: ) | Matches packets up to a limited rate (packet rate or bit rate). A rule using this matcher will match until this limit is reached. Parameters are written in the following format: rate[/time],burst:mode .- rate - packet or bit count per time interval to match
- time - specifies the time interval in which the packet or bit rate cannot be exceeded (optional, 1s will be used if not specified)
- burst - initial number of packets or bits to match: this number gets recharged every 10ms so burst should be at least 1/100 of a rate per second
- mode - packet or bit mode
|
log (yes | no; Default: no) | Add a message to the system log containing the following data: in-interface, out-interface, src-mac, protocol, src-ip:port->dst-ip:port, and length of the packet. |
log-prefix (string; Default: ) | Adds specified text at the beginning of every log message. Applicable if action=log or log=yes configured. |
nth (integer,integer; Default: ) | Matches every nth packet: nth=2,1 rule will match every first packet of 2, hence, 50% of all the traffic that is matched by the rule |
out-bridge-port (name; Default: ) | Actual interface the packet leaves the router if the outgoing interface is a bridge. Works only if use-ip-firewall is enabled in bridge settings. |
out-bridge-port-list (name; Default: ) | Set of interfaces defined in interface list. Works the same as out-bridge-port |
out-interface (; Default: ) | Interface the packet is leaving the router |
out-interface-list (name; Default: ) | Set of interfaces defined in interface list. Works the same as out-interface |
packet-mark (no-mark | string; Default: ) | Matches packets marked via mangle facility with particular packet mark. If no-mark is set, the rule will match any unmarked packet. |
packet-size (integer[-integer]:0..65535; Default: ) | Matches packets of specified size or size range in bytes. |
per-connection-classifier (ValuesToHash:Denominator/Remainder; Default: ) | PCC matcher allows dividing traffic into equal streams with the ability to keep packets with a specific set of options in one particular stream. |
port (integer[-integer]: 0..65535; Default: ) | Matches if any (source or destination) port matches the specified list of ports or port ranges. Applicable only if protocol is TCP or UDP |
priority (integer: 0..63; Default:) | Matches the packet's priority after a new priority has been set. Priority may be derived from VLAN, WMM, DSCP, MPLS EXP bit, or from the priority that has been set using the set-priority action. |
protocol (name or protocol ID; Default: tcp) | Matches particular IP protocol specified by protocol name or number |
random (integer: 1..99; Default: ) | Matches packets randomly with a given probability |
reject-with (icmp-address-unreachable | icmp-admin-prohibited | icmp-no-route | icmp-not-neighbour | icmp-port-unreachable | tcp-reset ; Default: icmp-no-route) | Specifies ICMP error to be sent back if the packet is rejected. Applicable if action=reject icmp-address-unreachable : sends ICMP address unreachable message icmp-admin-prohibited : sends ICMP address prohibited message icmp-no-route : sends ICMP address no-route message icmp-not-neighbour : sends ICMP address not-member message icmp-port-unreachable : sends ICMP port unreachable message tcp-reset : sends ICMP resetting a TCP connection
|
routing-mark (string; Default: ) | Matches packets marked by mangle facility with particular routing mark |
src-address (Ip/Netmask, Ip range; Default: ) | Matches packets whose source is equal to a specified IP or falls into a specified IP range |
src-address-list (name; Default: ) | Matches the source address of a packet against a user-defined address list |
src-address-type (unicast | local | broadcast | multicast; Default: ) | Matches source address type: unicast - IP address used for point-to-point transmissionlocal - if an address is assigned to one of the router's interfacesbroadcast - packet is sent to all devices in the subnetmulticast - packet is forwarded to a defined group of devices
|
src-port (integer[-integer]: 0..65535; Default: ) | List of source ports and ranges of source ports. Applicable only if a protocol is TCP or UDP |
src-mac-address (MAC address; Default: ) | Matches the source MAC address of the packet |
tcp-flags (ack | cwr | ece | fin | psh | rst | syn | urg; Default: ) | Matches specified TCP flagsack - acknowledging datacwr - congestion window reducedece - ECN-echo flag (explicit congestion notification)fin - close connectionpsh - push functionrst - drop connectionsyn - new connectionurg - urgent data
|
tcp-mss (integer[-integer]: 0..65535; Default: ) | Matches the TCP MSS value of an IP packet |
time (time-time,sat | fri | thu | wed | tue | mon | sun; Default: ) | Allows to create a filter based on the packets' arrival time and date or, for locally generated packets, departure time and date |
tls-host (string; Default: ) | Allows matching HTTPS traffic based on TLS SNI hostname. Accepts GLOB syntax for wildcard matching. Note that the matcher will not be able to match the hostname if the TLS handshake frame is fragmented into multiple TCP segments (packets). |