Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Routeros Provider
  3. API Docs
  4. ToolSniffer
routeros 1.83.0 published on Wednesday, Apr 16, 2025 by terraform-routeros
terraform-routeros/terraform-provider-routeros

routeros.ToolSniffer

Explore with Pulumi AI

routeros 1.83.0 published on Wednesday, Apr 16, 2025 by terraform-routeros
terraform-routeros/terraform-provider-routeros

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as routeros from "@pulumi/routeros";

const test = new routeros.ToolSniffer("test", {
    enabled: true,
    filterDirection: "rx",
    filterInterfaces: ["ether2"],
    filterOperatorBetweenEntries: "and",
    filterStream: true,
    streamingEnabled: true,
    streamingServer: "192.168.88.5:37008",
});
Copy
import pulumi
import pulumi_routeros as routeros

test = routeros.ToolSniffer("test",
    enabled=True,
    filter_direction="rx",
    filter_interfaces=["ether2"],
    filter_operator_between_entries="and",
    filter_stream=True,
    streaming_enabled=True,
    streaming_server="192.168.88.5:37008")
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/routeros/routeros"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := routeros.NewToolSniffer(ctx, "test", &routeros.ToolSnifferArgs{
			Enabled:         pulumi.Bool(true),
			FilterDirection: pulumi.String("rx"),
			FilterInterfaces: pulumi.StringArray{
				pulumi.String("ether2"),
			},
			FilterOperatorBetweenEntries: pulumi.String("and"),
			FilterStream:                 pulumi.Bool(true),
			StreamingEnabled:             pulumi.Bool(true),
			StreamingServer:              pulumi.String("192.168.88.5:37008"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Routeros = Pulumi.Routeros;

return await Deployment.RunAsync(() => 
{
    var test = new Routeros.ToolSniffer("test", new()
    {
        Enabled = true,
        FilterDirection = "rx",
        FilterInterfaces = new[]
        {
            "ether2",
        },
        FilterOperatorBetweenEntries = "and",
        FilterStream = true,
        StreamingEnabled = true,
        StreamingServer = "192.168.88.5:37008",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.routeros.ToolSniffer;
import com.pulumi.routeros.ToolSnifferArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var test = new ToolSniffer("test", ToolSnifferArgs.builder()
            .enabled(true)
            .filterDirection("rx")
            .filterInterfaces("ether2")
            .filterOperatorBetweenEntries("and")
            .filterStream(true)
            .streamingEnabled(true)
            .streamingServer("192.168.88.5:37008")
            .build());

    }
}
Copy
resources:
  test:
    type: routeros:ToolSniffer
    properties:
      enabled: true
      filterDirection: rx
      filterInterfaces:
        - ether2
      filterOperatorBetweenEntries: and
      filterStream: true
      streamingEnabled: true
      streamingServer: 192.168.88.5:37008
Copy

Create ToolSniffer Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new ToolSniffer(name: string, args?: ToolSnifferArgs, opts?: CustomResourceOptions);
@overload
def ToolSniffer(resource_name: str,
                args: Optional[ToolSnifferArgs] = None,
                opts: Optional[ResourceOptions] = None)

@overload
def ToolSniffer(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                ___id_: Optional[float] = None,
                ___path_: Optional[str] = None,
                ___skip_: Optional[str] = None,
                enabled: Optional[bool] = None,
                file_limit: Optional[float] = None,
                file_name: Optional[str] = None,
                filter_cpu: Optional[str] = None,
                filter_direction: Optional[str] = None,
                filter_dst_ip_addresses: Optional[Sequence[str]] = None,
                filter_dst_ipv6_addresses: Optional[Sequence[str]] = None,
                filter_dst_mac_addresses: Optional[Sequence[str]] = None,
                filter_dst_ports: Optional[Sequence[str]] = None,
                filter_interfaces: Optional[Sequence[str]] = None,
                filter_ip_addresses: Optional[Sequence[str]] = None,
                filter_ip_protocols: Optional[Sequence[str]] = None,
                filter_ipv6_addresses: Optional[Sequence[str]] = None,
                filter_mac_addresses: Optional[Sequence[str]] = None,
                filter_mac_protocols: Optional[Sequence[str]] = None,
                filter_operator_between_entries: Optional[str] = None,
                filter_ports: Optional[Sequence[str]] = None,
                filter_size: Optional[str] = None,
                filter_src_ip_addresses: Optional[Sequence[str]] = None,
                filter_src_ipv6_addresses: Optional[Sequence[str]] = None,
                filter_src_mac_addresses: Optional[Sequence[str]] = None,
                filter_src_ports: Optional[Sequence[str]] = None,
                filter_stream: Optional[bool] = None,
                filter_vlans: Optional[Sequence[float]] = None,
                memory_limit: Optional[float] = None,
                memory_scroll: Optional[bool] = None,
                only_headers: Optional[bool] = None,
                streaming_enabled: Optional[bool] = None,
                streaming_server: Optional[str] = None,
                tool_sniffer_id: Optional[str] = None)
func NewToolSniffer(ctx *Context, name string, args *ToolSnifferArgs, opts ...ResourceOption) (*ToolSniffer, error)
public ToolSniffer(string name, ToolSnifferArgs? args = null, CustomResourceOptions? opts = null)
public ToolSniffer(String name, ToolSnifferArgs args)
public ToolSniffer(String name, ToolSnifferArgs args, CustomResourceOptions options)

type: routeros:ToolSniffer
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args ToolSnifferArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args ToolSnifferArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args ToolSnifferArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args ToolSnifferArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ToolSnifferArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

ToolSniffer Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The ToolSniffer resource accepts the following input properties:

Enabled bool
Start packet capture.
FileLimit double
File size limit. Sniffer will stop when a limit is reached.
FileName string
Name of the file where sniffed packets will be saved.
FilterCpu string
CPU core used as a filter.
FilterDirection string
Specifies which direction filtering will be applied.
FilterDstIpAddresses List<string>
Up to 16 IP destination addresses used as a filter.
FilterDstIpv6Addresses List<string>
Up to 16 IPv6 destination addresses used as a filter.
FilterDstMacAddresses List<string>
Up to 16 MAC destination addresses and MAC address masks used as a filter.
FilterDstPorts List<string>
Up to 16 comma-separated destination ports used as a filter. A list of predefined port names is also available, like ssh and telnet.
FilterInterfaces List<string>
Interface name on which sniffer will be running. all indicates that the sniffer will sniff packets on all interfaces.
FilterIpAddresses List<string>
Up to 16 IP addresses used as a filter.
FilterIpProtocols List<string>
Up to 16 comma-separated IP/IPv6 protocols used as a filter. IP protocols (instead of protocol names, protocol numbers can be used): * ipsec-ah - IPsec AH protocol * ipsec-esp - IPsec ESP protocol * ddp - datagram delivery protocol * egp - exterior gateway protocol * ggp - gateway-gateway protocol * gre - general routing encapsulation * hmp - host monitoring protocol * idpr-cmtp - idpr control message transport * icmp - internet control message protocol * icmpv6 - internet control message protocol v6 * igmp - internet group management protocol * ipencap - ip encapsulated in ip * ipip - ip encapsulation * encap - ip encapsulation * iso-tp4 - iso transport protocol class 4 * ospf - open shortest path first * pup - parc universal packet protocol * pim - protocol independent multicast * rspf - radio shortest path first * rdp - reliable datagram protocol * st - st datagram mode * tcp - transmission control protocol * udp - user datagram protocol

  • vmtp versatile message transport * vrrp - virtual router redundancy protocol * xns-idp - xerox xns idp * xtp - xpress transfer protocol
FilterIpv6Addresses List<string>
Up to 16 IPv6 addresses used as a filter.
FilterMacAddresses List<string>
Up to 16 MAC addresses and MAC address masks used as a filter.
FilterMacProtocols List<string>
Up to 16 comma separated entries used as a filter. Mac protocols (instead of protocol names, protocol number can be used): * 802.2 - 802.2 Frames (0x0004) * arp - Address Resolution Protocol (0x0806) * homeplug-av - HomePlug AV MME (0x88E1) * ip - Internet Protocol version 4 (0x0800) * ipv6 - Internet Protocol Version 6 (0x86DD) * ipx - Internetwork Packet Exchange (0x8137) * lldp - Link Layer Discovery Protocol (0x88CC) * loop-protect - Loop Protect Protocol (0x9003)

  • mpls-multicast - MPLS multicast (0x8848) * mpls-unicast - MPLS unicast (0x8847) * packing-compr - Encapsulated packets with compressed IP packing (0x9001) * packing-simple - Encapsulated packets with simple IP packing (0x9000) * pppoe - PPPoE Session Stage (0x8864) * pppoe-discovery - PPPoE Discovery Stage (0x8863) * rarp - Reverse Address Resolution Protocol (0x8035) * service-vlan - Provider Bridging (IEEE 802.1ad) & Shortest Path Bridging IEEE 802.1aq (0x88A8) * vlan - VLAN-tagged frame (IEEE 802.1Q) and Shortest Path Bridging IEEE 802.1aq with NNI compatibility (0x8100)
FilterOperatorBetweenEntries string
Changes the logic for filters with multiple entries.
FilterPorts List<string>
Up to 16 comma-separated ports used as a filter. A list of predefined port names is also available, like ssh and telnet.
FilterSize string
Filters packets of specified size or size range in bytes.
FilterSrcIpAddresses List<string>
Up to 16 IP source addresses used as a filter.
FilterSrcIpv6Addresses List<string>
Up to 16 IPv6 source addresses used as a filter.
FilterSrcMacAddresses List<string>
Up to 16 MAC source addresses and MAC address masks used as a filter.
FilterSrcPorts List<string>
Up to 16 comma-separated source ports used as a filter. A list of predefined port names is also available, like ssh and telnet.
FilterStream bool
Sniffed packets that are devised for the sniffer server are ignored.
FilterVlans List<double>
Up to 16 VLAN IDs used as a filter.
MemoryLimit double
Memory amount used to store sniffed data.
MemoryScroll bool
Whether to rewrite older sniffed data when the memory limit is reached.
OnlyHeaders bool
Save in the memory only the packet's headers, not the whole packet.
StreamingEnabled bool
Defines whether to send sniffed packets to the streaming server.
StreamingServer string
Tazmen Sniffer Protocol (TZSP) stream receiver.
ToolSnifferId string
___id_ double
Resource ID type (.id / name). This is an internal service field, setting a value is not required.
___path_ string
Resource path for CRUD operations. This is an internal service field, setting a value is not required.
___skip_ string
A set of transformations for field names. This is an internal service field, setting a value is not required.
Enabled bool
Start packet capture.
FileLimit float64
File size limit. Sniffer will stop when a limit is reached.
FileName string
Name of the file where sniffed packets will be saved.
FilterCpu string
CPU core used as a filter.
FilterDirection string
Specifies which direction filtering will be applied.
FilterDstIpAddresses []string
Up to 16 IP destination addresses used as a filter.
FilterDstIpv6Addresses []string
Up to 16 IPv6 destination addresses used as a filter.
FilterDstMacAddresses []string
Up to 16 MAC destination addresses and MAC address masks used as a filter.
FilterDstPorts []string
Up to 16 comma-separated destination ports used as a filter. A list of predefined port names is also available, like ssh and telnet.
FilterInterfaces []string
Interface name on which sniffer will be running. all indicates that the sniffer will sniff packets on all interfaces.
FilterIpAddresses []string
Up to 16 IP addresses used as a filter.
FilterIpProtocols []string
Up to 16 comma-separated IP/IPv6 protocols used as a filter. IP protocols (instead of protocol names, protocol numbers can be used): * ipsec-ah - IPsec AH protocol * ipsec-esp - IPsec ESP protocol * ddp - datagram delivery protocol * egp - exterior gateway protocol * ggp - gateway-gateway protocol * gre - general routing encapsulation * hmp - host monitoring protocol * idpr-cmtp - idpr control message transport * icmp - internet control message protocol * icmpv6 - internet control message protocol v6 * igmp - internet group management protocol * ipencap - ip encapsulated in ip * ipip - ip encapsulation * encap - ip encapsulation * iso-tp4 - iso transport protocol class 4 * ospf - open shortest path first * pup - parc universal packet protocol * pim - protocol independent multicast * rspf - radio shortest path first * rdp - reliable datagram protocol * st - st datagram mode * tcp - transmission control protocol * udp - user datagram protocol

  • vmtp versatile message transport * vrrp - virtual router redundancy protocol * xns-idp - xerox xns idp * xtp - xpress transfer protocol
FilterIpv6Addresses []string
Up to 16 IPv6 addresses used as a filter.
FilterMacAddresses []string
Up to 16 MAC addresses and MAC address masks used as a filter.
FilterMacProtocols []string
Up to 16 comma separated entries used as a filter. Mac protocols (instead of protocol names, protocol number can be used): * 802.2 - 802.2 Frames (0x0004) * arp - Address Resolution Protocol (0x0806) * homeplug-av - HomePlug AV MME (0x88E1) * ip - Internet Protocol version 4 (0x0800) * ipv6 - Internet Protocol Version 6 (0x86DD) * ipx - Internetwork Packet Exchange (0x8137) * lldp - Link Layer Discovery Protocol (0x88CC) * loop-protect - Loop Protect Protocol (0x9003)

  • mpls-multicast - MPLS multicast (0x8848) * mpls-unicast - MPLS unicast (0x8847) * packing-compr - Encapsulated packets with compressed IP packing (0x9001) * packing-simple - Encapsulated packets with simple IP packing (0x9000) * pppoe - PPPoE Session Stage (0x8864) * pppoe-discovery - PPPoE Discovery Stage (0x8863) * rarp - Reverse Address Resolution Protocol (0x8035) * service-vlan - Provider Bridging (IEEE 802.1ad) & Shortest Path Bridging IEEE 802.1aq (0x88A8) * vlan - VLAN-tagged frame (IEEE 802.1Q) and Shortest Path Bridging IEEE 802.1aq with NNI compatibility (0x8100)
FilterOperatorBetweenEntries string
Changes the logic for filters with multiple entries.
FilterPorts []string
Up to 16 comma-separated ports used as a filter. A list of predefined port names is also available, like ssh and telnet.
FilterSize string
Filters packets of specified size or size range in bytes.
FilterSrcIpAddresses []string
Up to 16 IP source addresses used as a filter.
FilterSrcIpv6Addresses []string
Up to 16 IPv6 source addresses used as a filter.
FilterSrcMacAddresses []string
Up to 16 MAC source addresses and MAC address masks used as a filter.
FilterSrcPorts []string
Up to 16 comma-separated source ports used as a filter. A list of predefined port names is also available, like ssh and telnet.
FilterStream bool
Sniffed packets that are devised for the sniffer server are ignored.
FilterVlans []float64
Up to 16 VLAN IDs used as a filter.
MemoryLimit float64
Memory amount used to store sniffed data.
MemoryScroll bool
Whether to rewrite older sniffed data when the memory limit is reached.
OnlyHeaders bool
Save in the memory only the packet's headers, not the whole packet.
StreamingEnabled bool
Defines whether to send sniffed packets to the streaming server.
StreamingServer string
Tazmen Sniffer Protocol (TZSP) stream receiver.
ToolSnifferId string
___id_ float64
Resource ID type (.id / name). This is an internal service field, setting a value is not required.
___path_ string
Resource path for CRUD operations. This is an internal service field, setting a value is not required.
___skip_ string
A set of transformations for field names. This is an internal service field, setting a value is not required.
___id_ Double
Resource ID type (.id / name). This is an internal service field, setting a value is not required.
___path_ String
Resource path for CRUD operations. This is an internal service field, setting a value is not required.
___skip_ String
A set of transformations for field names. This is an internal service field, setting a value is not required.
enabled Boolean
Start packet capture.
fileLimit Double
File size limit. Sniffer will stop when a limit is reached.
fileName String
Name of the file where sniffed packets will be saved.
filterCpu String
CPU core used as a filter.
filterDirection String
Specifies which direction filtering will be applied.
filterDstIpAddresses List<String>
Up to 16 IP destination addresses used as a filter.
filterDstIpv6Addresses List<String>
Up to 16 IPv6 destination addresses used as a filter.
filterDstMacAddresses List<String>
Up to 16 MAC destination addresses and MAC address masks used as a filter.
filterDstPorts List<String>
Up to 16 comma-separated destination ports used as a filter. A list of predefined port names is also available, like ssh and telnet.
filterInterfaces List<String>
Interface name on which sniffer will be running. all indicates that the sniffer will sniff packets on all interfaces.
filterIpAddresses List<String>
Up to 16 IP addresses used as a filter.
filterIpProtocols List<String>
Up to 16 comma-separated IP/IPv6 protocols used as a filter. IP protocols (instead of protocol names, protocol numbers can be used): * ipsec-ah - IPsec AH protocol * ipsec-esp - IPsec ESP protocol * ddp - datagram delivery protocol * egp - exterior gateway protocol * ggp - gateway-gateway protocol * gre - general routing encapsulation * hmp - host monitoring protocol * idpr-cmtp - idpr control message transport * icmp - internet control message protocol * icmpv6 - internet control message protocol v6 * igmp - internet group management protocol * ipencap - ip encapsulated in ip * ipip - ip encapsulation * encap - ip encapsulation * iso-tp4 - iso transport protocol class 4 * ospf - open shortest path first * pup - parc universal packet protocol * pim - protocol independent multicast * rspf - radio shortest path first * rdp - reliable datagram protocol * st - st datagram mode * tcp - transmission control protocol * udp - user datagram protocol

  • vmtp versatile message transport * vrrp - virtual router redundancy protocol * xns-idp - xerox xns idp * xtp - xpress transfer protocol
filterIpv6Addresses List<String>
Up to 16 IPv6 addresses used as a filter.
filterMacAddresses List<String>
Up to 16 MAC addresses and MAC address masks used as a filter.
filterMacProtocols List<String>
Up to 16 comma separated entries used as a filter. Mac protocols (instead of protocol names, protocol number can be used): * 802.2 - 802.2 Frames (0x0004) * arp - Address Resolution Protocol (0x0806) * homeplug-av - HomePlug AV MME (0x88E1) * ip - Internet Protocol version 4 (0x0800) * ipv6 - Internet Protocol Version 6 (0x86DD) * ipx - Internetwork Packet Exchange (0x8137) * lldp - Link Layer Discovery Protocol (0x88CC) * loop-protect - Loop Protect Protocol (0x9003)

  • mpls-multicast - MPLS multicast (0x8848) * mpls-unicast - MPLS unicast (0x8847) * packing-compr - Encapsulated packets with compressed IP packing (0x9001) * packing-simple - Encapsulated packets with simple IP packing (0x9000) * pppoe - PPPoE Session Stage (0x8864) * pppoe-discovery - PPPoE Discovery Stage (0x8863) * rarp - Reverse Address Resolution Protocol (0x8035) * service-vlan - Provider Bridging (IEEE 802.1ad) & Shortest Path Bridging IEEE 802.1aq (0x88A8) * vlan - VLAN-tagged frame (IEEE 802.1Q) and Shortest Path Bridging IEEE 802.1aq with NNI compatibility (0x8100)
filterOperatorBetweenEntries String
Changes the logic for filters with multiple entries.
filterPorts List<String>
Up to 16 comma-separated ports used as a filter. A list of predefined port names is also available, like ssh and telnet.
filterSize String
Filters packets of specified size or size range in bytes.
filterSrcIpAddresses List<String>
Up to 16 IP source addresses used as a filter.
filterSrcIpv6Addresses List<String>
Up to 16 IPv6 source addresses used as a filter.
filterSrcMacAddresses List<String>
Up to 16 MAC source addresses and MAC address masks used as a filter.
filterSrcPorts List<String>
Up to 16 comma-separated source ports used as a filter. A list of predefined port names is also available, like ssh and telnet.
filterStream Boolean
Sniffed packets that are devised for the sniffer server are ignored.
filterVlans List<Double>
Up to 16 VLAN IDs used as a filter.
memoryLimit Double
Memory amount used to store sniffed data.
memoryScroll Boolean
Whether to rewrite older sniffed data when the memory limit is reached.
onlyHeaders Boolean
Save in the memory only the packet's headers, not the whole packet.
streamingEnabled Boolean
Defines whether to send sniffed packets to the streaming server.
streamingServer String
Tazmen Sniffer Protocol (TZSP) stream receiver.
toolSnifferId String
___id_ number
Resource ID type (.id / name). This is an internal service field, setting a value is not required.
___path_ string
Resource path for CRUD operations. This is an internal service field, setting a value is not required.
___skip_ string
A set of transformations for field names. This is an internal service field, setting a value is not required.
enabled boolean
Start packet capture.
fileLimit number
File size limit. Sniffer will stop when a limit is reached.
fileName string
Name of the file where sniffed packets will be saved.
filterCpu string
CPU core used as a filter.
filterDirection string
Specifies which direction filtering will be applied.
filterDstIpAddresses string[]
Up to 16 IP destination addresses used as a filter.
filterDstIpv6Addresses string[]
Up to 16 IPv6 destination addresses used as a filter.
filterDstMacAddresses string[]
Up to 16 MAC destination addresses and MAC address masks used as a filter.
filterDstPorts string[]
Up to 16 comma-separated destination ports used as a filter. A list of predefined port names is also available, like ssh and telnet.
filterInterfaces string[]
Interface name on which sniffer will be running. all indicates that the sniffer will sniff packets on all interfaces.
filterIpAddresses string[]
Up to 16 IP addresses used as a filter.
filterIpProtocols string[]
Up to 16 comma-separated IP/IPv6 protocols used as a filter. IP protocols (instead of protocol names, protocol numbers can be used): * ipsec-ah - IPsec AH protocol * ipsec-esp - IPsec ESP protocol * ddp - datagram delivery protocol * egp - exterior gateway protocol * ggp - gateway-gateway protocol * gre - general routing encapsulation * hmp - host monitoring protocol * idpr-cmtp - idpr control message transport * icmp - internet control message protocol * icmpv6 - internet control message protocol v6 * igmp - internet group management protocol * ipencap - ip encapsulated in ip * ipip - ip encapsulation * encap - ip encapsulation * iso-tp4 - iso transport protocol class 4 * ospf - open shortest path first * pup - parc universal packet protocol * pim - protocol independent multicast * rspf - radio shortest path first * rdp - reliable datagram protocol * st - st datagram mode * tcp - transmission control protocol * udp - user datagram protocol

  • vmtp versatile message transport * vrrp - virtual router redundancy protocol * xns-idp - xerox xns idp * xtp - xpress transfer protocol
filterIpv6Addresses string[]
Up to 16 IPv6 addresses used as a filter.
filterMacAddresses string[]
Up to 16 MAC addresses and MAC address masks used as a filter.
filterMacProtocols string[]
Up to 16 comma separated entries used as a filter. Mac protocols (instead of protocol names, protocol number can be used): * 802.2 - 802.2 Frames (0x0004) * arp - Address Resolution Protocol (0x0806) * homeplug-av - HomePlug AV MME (0x88E1) * ip - Internet Protocol version 4 (0x0800) * ipv6 - Internet Protocol Version 6 (0x86DD) * ipx - Internetwork Packet Exchange (0x8137) * lldp - Link Layer Discovery Protocol (0x88CC) * loop-protect - Loop Protect Protocol (0x9003)

  • mpls-multicast - MPLS multicast (0x8848) * mpls-unicast - MPLS unicast (0x8847) * packing-compr - Encapsulated packets with compressed IP packing (0x9001) * packing-simple - Encapsulated packets with simple IP packing (0x9000) * pppoe - PPPoE Session Stage (0x8864) * pppoe-discovery - PPPoE Discovery Stage (0x8863) * rarp - Reverse Address Resolution Protocol (0x8035) * service-vlan - Provider Bridging (IEEE 802.1ad) & Shortest Path Bridging IEEE 802.1aq (0x88A8) * vlan - VLAN-tagged frame (IEEE 802.1Q) and Shortest Path Bridging IEEE 802.1aq with NNI compatibility (0x8100)
filterOperatorBetweenEntries string
Changes the logic for filters with multiple entries.
filterPorts string[]
Up to 16 comma-separated ports used as a filter. A list of predefined port names is also available, like ssh and telnet.
filterSize string
Filters packets of specified size or size range in bytes.
filterSrcIpAddresses string[]
Up to 16 IP source addresses used as a filter.
filterSrcIpv6Addresses string[]
Up to 16 IPv6 source addresses used as a filter.
filterSrcMacAddresses string[]
Up to 16 MAC source addresses and MAC address masks used as a filter.
filterSrcPorts string[]
Up to 16 comma-separated source ports used as a filter. A list of predefined port names is also available, like ssh and telnet.
filterStream boolean
Sniffed packets that are devised for the sniffer server are ignored.
filterVlans number[]
Up to 16 VLAN IDs used as a filter.
memoryLimit number
Memory amount used to store sniffed data.
memoryScroll boolean
Whether to rewrite older sniffed data when the memory limit is reached.
onlyHeaders boolean
Save in the memory only the packet's headers, not the whole packet.
streamingEnabled boolean
Defines whether to send sniffed packets to the streaming server.
streamingServer string
Tazmen Sniffer Protocol (TZSP) stream receiver.
toolSnifferId string
___id_ float
Resource ID type (.id / name). This is an internal service field, setting a value is not required.
___path_ str
Resource path for CRUD operations. This is an internal service field, setting a value is not required.
___skip_ str
A set of transformations for field names. This is an internal service field, setting a value is not required.
enabled bool
Start packet capture.
file_limit float
File size limit. Sniffer will stop when a limit is reached.
file_name str
Name of the file where sniffed packets will be saved.
filter_cpu str
CPU core used as a filter.
filter_direction str
Specifies which direction filtering will be applied.
filter_dst_ip_addresses Sequence[str]
Up to 16 IP destination addresses used as a filter.
filter_dst_ipv6_addresses Sequence[str]
Up to 16 IPv6 destination addresses used as a filter.
filter_dst_mac_addresses Sequence[str]
Up to 16 MAC destination addresses and MAC address masks used as a filter.
filter_dst_ports Sequence[str]
Up to 16 comma-separated destination ports used as a filter. A list of predefined port names is also available, like ssh and telnet.
filter_interfaces Sequence[str]
Interface name on which sniffer will be running. all indicates that the sniffer will sniff packets on all interfaces.
filter_ip_addresses Sequence[str]
Up to 16 IP addresses used as a filter.
filter_ip_protocols Sequence[str]
Up to 16 comma-separated IP/IPv6 protocols used as a filter. IP protocols (instead of protocol names, protocol numbers can be used): * ipsec-ah - IPsec AH protocol * ipsec-esp - IPsec ESP protocol * ddp - datagram delivery protocol * egp - exterior gateway protocol * ggp - gateway-gateway protocol * gre - general routing encapsulation * hmp - host monitoring protocol * idpr-cmtp - idpr control message transport * icmp - internet control message protocol * icmpv6 - internet control message protocol v6 * igmp - internet group management protocol * ipencap - ip encapsulated in ip * ipip - ip encapsulation * encap - ip encapsulation * iso-tp4 - iso transport protocol class 4 * ospf - open shortest path first * pup - parc universal packet protocol * pim - protocol independent multicast * rspf - radio shortest path first * rdp - reliable datagram protocol * st - st datagram mode * tcp - transmission control protocol * udp - user datagram protocol

  • vmtp versatile message transport * vrrp - virtual router redundancy protocol * xns-idp - xerox xns idp * xtp - xpress transfer protocol
filter_ipv6_addresses Sequence[str]
Up to 16 IPv6 addresses used as a filter.
filter_mac_addresses Sequence[str]
Up to 16 MAC addresses and MAC address masks used as a filter.
filter_mac_protocols Sequence[str]
Up to 16 comma separated entries used as a filter. Mac protocols (instead of protocol names, protocol number can be used): * 802.2 - 802.2 Frames (0x0004) * arp - Address Resolution Protocol (0x0806) * homeplug-av - HomePlug AV MME (0x88E1) * ip - Internet Protocol version 4 (0x0800) * ipv6 - Internet Protocol Version 6 (0x86DD) * ipx - Internetwork Packet Exchange (0x8137) * lldp - Link Layer Discovery Protocol (0x88CC) * loop-protect - Loop Protect Protocol (0x9003)

  • mpls-multicast - MPLS multicast (0x8848) * mpls-unicast - MPLS unicast (0x8847) * packing-compr - Encapsulated packets with compressed IP packing (0x9001) * packing-simple - Encapsulated packets with simple IP packing (0x9000) * pppoe - PPPoE Session Stage (0x8864) * pppoe-discovery - PPPoE Discovery Stage (0x8863) * rarp - Reverse Address Resolution Protocol (0x8035) * service-vlan - Provider Bridging (IEEE 802.1ad) & Shortest Path Bridging IEEE 802.1aq (0x88A8) * vlan - VLAN-tagged frame (IEEE 802.1Q) and Shortest Path Bridging IEEE 802.1aq with NNI compatibility (0x8100)
filter_operator_between_entries str
Changes the logic for filters with multiple entries.
filter_ports Sequence[str]
Up to 16 comma-separated ports used as a filter. A list of predefined port names is also available, like ssh and telnet.
filter_size str
Filters packets of specified size or size range in bytes.
filter_src_ip_addresses Sequence[str]
Up to 16 IP source addresses used as a filter.
filter_src_ipv6_addresses Sequence[str]
Up to 16 IPv6 source addresses used as a filter.
filter_src_mac_addresses Sequence[str]
Up to 16 MAC source addresses and MAC address masks used as a filter.
filter_src_ports Sequence[str]
Up to 16 comma-separated source ports used as a filter. A list of predefined port names is also available, like ssh and telnet.
filter_stream bool
Sniffed packets that are devised for the sniffer server are ignored.
filter_vlans Sequence[float]
Up to 16 VLAN IDs used as a filter.
memory_limit float
Memory amount used to store sniffed data.
memory_scroll bool
Whether to rewrite older sniffed data when the memory limit is reached.
only_headers bool
Save in the memory only the packet's headers, not the whole packet.
streaming_enabled bool
Defines whether to send sniffed packets to the streaming server.
streaming_server str
Tazmen Sniffer Protocol (TZSP) stream receiver.
tool_sniffer_id str
___id_ Number
Resource ID type (.id / name). This is an internal service field, setting a value is not required.
___path_ String
Resource path for CRUD operations. This is an internal service field, setting a value is not required.
___skip_ String
A set of transformations for field names. This is an internal service field, setting a value is not required.
enabled Boolean
Start packet capture.
fileLimit Number
File size limit. Sniffer will stop when a limit is reached.
fileName String
Name of the file where sniffed packets will be saved.
filterCpu String
CPU core used as a filter.
filterDirection String
Specifies which direction filtering will be applied.
filterDstIpAddresses List<String>
Up to 16 IP destination addresses used as a filter.
filterDstIpv6Addresses List<String>
Up to 16 IPv6 destination addresses used as a filter.
filterDstMacAddresses List<String>
Up to 16 MAC destination addresses and MAC address masks used as a filter.
filterDstPorts List<String>
Up to 16 comma-separated destination ports used as a filter. A list of predefined port names is also available, like ssh and telnet.
filterInterfaces List<String>
Interface name on which sniffer will be running. all indicates that the sniffer will sniff packets on all interfaces.
filterIpAddresses List<String>
Up to 16 IP addresses used as a filter.
filterIpProtocols List<String>
Up to 16 comma-separated IP/IPv6 protocols used as a filter. IP protocols (instead of protocol names, protocol numbers can be used): * ipsec-ah - IPsec AH protocol * ipsec-esp - IPsec ESP protocol * ddp - datagram delivery protocol * egp - exterior gateway protocol * ggp - gateway-gateway protocol * gre - general routing encapsulation * hmp - host monitoring protocol * idpr-cmtp - idpr control message transport * icmp - internet control message protocol * icmpv6 - internet control message protocol v6 * igmp - internet group management protocol * ipencap - ip encapsulated in ip * ipip - ip encapsulation * encap - ip encapsulation * iso-tp4 - iso transport protocol class 4 * ospf - open shortest path first * pup - parc universal packet protocol * pim - protocol independent multicast * rspf - radio shortest path first * rdp - reliable datagram protocol * st - st datagram mode * tcp - transmission control protocol * udp - user datagram protocol

  • vmtp versatile message transport * vrrp - virtual router redundancy protocol * xns-idp - xerox xns idp * xtp - xpress transfer protocol
filterIpv6Addresses List<String>
Up to 16 IPv6 addresses used as a filter.
filterMacAddresses List<String>
Up to 16 MAC addresses and MAC address masks used as a filter.
filterMacProtocols List<String>
Up to 16 comma separated entries used as a filter. Mac protocols (instead of protocol names, protocol number can be used): * 802.2 - 802.2 Frames (0x0004) * arp - Address Resolution Protocol (0x0806) * homeplug-av - HomePlug AV MME (0x88E1) * ip - Internet Protocol version 4 (0x0800) * ipv6 - Internet Protocol Version 6 (0x86DD) * ipx - Internetwork Packet Exchange (0x8137) * lldp - Link Layer Discovery Protocol (0x88CC) * loop-protect - Loop Protect Protocol (0x9003)

  • mpls-multicast - MPLS multicast (0x8848) * mpls-unicast - MPLS unicast (0x8847) * packing-compr - Encapsulated packets with compressed IP packing (0x9001) * packing-simple - Encapsulated packets with simple IP packing (0x9000) * pppoe - PPPoE Session Stage (0x8864) * pppoe-discovery - PPPoE Discovery Stage (0x8863) * rarp - Reverse Address Resolution Protocol (0x8035) * service-vlan - Provider Bridging (IEEE 802.1ad) & Shortest Path Bridging IEEE 802.1aq (0x88A8) * vlan - VLAN-tagged frame (IEEE 802.1Q) and Shortest Path Bridging IEEE 802.1aq with NNI compatibility (0x8100)
filterOperatorBetweenEntries String
Changes the logic for filters with multiple entries.
filterPorts List<String>
Up to 16 comma-separated ports used as a filter. A list of predefined port names is also available, like ssh and telnet.
filterSize String
Filters packets of specified size or size range in bytes.
filterSrcIpAddresses List<String>
Up to 16 IP source addresses used as a filter.
filterSrcIpv6Addresses List<String>
Up to 16 IPv6 source addresses used as a filter.
filterSrcMacAddresses List<String>
Up to 16 MAC source addresses and MAC address masks used as a filter.
filterSrcPorts List<String>
Up to 16 comma-separated source ports used as a filter. A list of predefined port names is also available, like ssh and telnet.
filterStream Boolean
Sniffed packets that are devised for the sniffer server are ignored.
filterVlans List<Number>
Up to 16 VLAN IDs used as a filter.
memoryLimit Number
Memory amount used to store sniffed data.
memoryScroll Boolean
Whether to rewrite older sniffed data when the memory limit is reached.
onlyHeaders Boolean
Save in the memory only the packet's headers, not the whole packet.
streamingEnabled Boolean
Defines whether to send sniffed packets to the streaming server.
streamingServer String
Tazmen Sniffer Protocol (TZSP) stream receiver.
toolSnifferId String

Outputs

All input properties are implicitly available as output properties. Additionally, the ToolSniffer resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Running bool
Id string
The provider-assigned unique ID for this managed resource.
Running bool
id String
The provider-assigned unique ID for this managed resource.
running Boolean
id string
The provider-assigned unique ID for this managed resource.
running boolean
id str
The provider-assigned unique ID for this managed resource.
running bool
id String
The provider-assigned unique ID for this managed resource.
running Boolean

Look up Existing ToolSniffer Resource

Get an existing ToolSniffer resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: ToolSnifferState, opts?: CustomResourceOptions): ToolSniffer
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        ___id_: Optional[float] = None,
        ___path_: Optional[str] = None,
        ___skip_: Optional[str] = None,
        enabled: Optional[bool] = None,
        file_limit: Optional[float] = None,
        file_name: Optional[str] = None,
        filter_cpu: Optional[str] = None,
        filter_direction: Optional[str] = None,
        filter_dst_ip_addresses: Optional[Sequence[str]] = None,
        filter_dst_ipv6_addresses: Optional[Sequence[str]] = None,
        filter_dst_mac_addresses: Optional[Sequence[str]] = None,
        filter_dst_ports: Optional[Sequence[str]] = None,
        filter_interfaces: Optional[Sequence[str]] = None,
        filter_ip_addresses: Optional[Sequence[str]] = None,
        filter_ip_protocols: Optional[Sequence[str]] = None,
        filter_ipv6_addresses: Optional[Sequence[str]] = None,
        filter_mac_addresses: Optional[Sequence[str]] = None,
        filter_mac_protocols: Optional[Sequence[str]] = None,
        filter_operator_between_entries: Optional[str] = None,
        filter_ports: Optional[Sequence[str]] = None,
        filter_size: Optional[str] = None,
        filter_src_ip_addresses: Optional[Sequence[str]] = None,
        filter_src_ipv6_addresses: Optional[Sequence[str]] = None,
        filter_src_mac_addresses: Optional[Sequence[str]] = None,
        filter_src_ports: Optional[Sequence[str]] = None,
        filter_stream: Optional[bool] = None,
        filter_vlans: Optional[Sequence[float]] = None,
        memory_limit: Optional[float] = None,
        memory_scroll: Optional[bool] = None,
        only_headers: Optional[bool] = None,
        running: Optional[bool] = None,
        streaming_enabled: Optional[bool] = None,
        streaming_server: Optional[str] = None,
        tool_sniffer_id: Optional[str] = None) -> ToolSniffer
func GetToolSniffer(ctx *Context, name string, id IDInput, state *ToolSnifferState, opts ...ResourceOption) (*ToolSniffer, error)
public static ToolSniffer Get(string name, Input<string> id, ToolSnifferState? state, CustomResourceOptions? opts = null)
public static ToolSniffer get(String name, Output<String> id, ToolSnifferState state, CustomResourceOptions options)
resources:  _:    type: routeros:ToolSniffer    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Enabled bool
Start packet capture.
FileLimit double
File size limit. Sniffer will stop when a limit is reached.
FileName string
Name of the file where sniffed packets will be saved.
FilterCpu string
CPU core used as a filter.
FilterDirection string
Specifies which direction filtering will be applied.
FilterDstIpAddresses List<string>
Up to 16 IP destination addresses used as a filter.
FilterDstIpv6Addresses List<string>
Up to 16 IPv6 destination addresses used as a filter.
FilterDstMacAddresses List<string>
Up to 16 MAC destination addresses and MAC address masks used as a filter.
FilterDstPorts List<string>
Up to 16 comma-separated destination ports used as a filter. A list of predefined port names is also available, like ssh and telnet.
FilterInterfaces List<string>
Interface name on which sniffer will be running. all indicates that the sniffer will sniff packets on all interfaces.
FilterIpAddresses List<string>
Up to 16 IP addresses used as a filter.
FilterIpProtocols List<string>
Up to 16 comma-separated IP/IPv6 protocols used as a filter. IP protocols (instead of protocol names, protocol numbers can be used): * ipsec-ah - IPsec AH protocol * ipsec-esp - IPsec ESP protocol * ddp - datagram delivery protocol * egp - exterior gateway protocol * ggp - gateway-gateway protocol * gre - general routing encapsulation * hmp - host monitoring protocol * idpr-cmtp - idpr control message transport * icmp - internet control message protocol * icmpv6 - internet control message protocol v6 * igmp - internet group management protocol * ipencap - ip encapsulated in ip * ipip - ip encapsulation * encap - ip encapsulation * iso-tp4 - iso transport protocol class 4 * ospf - open shortest path first * pup - parc universal packet protocol * pim - protocol independent multicast * rspf - radio shortest path first * rdp - reliable datagram protocol * st - st datagram mode * tcp - transmission control protocol * udp - user datagram protocol

  • vmtp versatile message transport * vrrp - virtual router redundancy protocol * xns-idp - xerox xns idp * xtp - xpress transfer protocol
FilterIpv6Addresses List<string>
Up to 16 IPv6 addresses used as a filter.
FilterMacAddresses List<string>
Up to 16 MAC addresses and MAC address masks used as a filter.
FilterMacProtocols List<string>
Up to 16 comma separated entries used as a filter. Mac protocols (instead of protocol names, protocol number can be used): * 802.2 - 802.2 Frames (0x0004) * arp - Address Resolution Protocol (0x0806) * homeplug-av - HomePlug AV MME (0x88E1) * ip - Internet Protocol version 4 (0x0800) * ipv6 - Internet Protocol Version 6 (0x86DD) * ipx - Internetwork Packet Exchange (0x8137) * lldp - Link Layer Discovery Protocol (0x88CC) * loop-protect - Loop Protect Protocol (0x9003)

  • mpls-multicast - MPLS multicast (0x8848) * mpls-unicast - MPLS unicast (0x8847) * packing-compr - Encapsulated packets with compressed IP packing (0x9001) * packing-simple - Encapsulated packets with simple IP packing (0x9000) * pppoe - PPPoE Session Stage (0x8864) * pppoe-discovery - PPPoE Discovery Stage (0x8863) * rarp - Reverse Address Resolution Protocol (0x8035) * service-vlan - Provider Bridging (IEEE 802.1ad) & Shortest Path Bridging IEEE 802.1aq (0x88A8) * vlan - VLAN-tagged frame (IEEE 802.1Q) and Shortest Path Bridging IEEE 802.1aq with NNI compatibility (0x8100)
FilterOperatorBetweenEntries string
Changes the logic for filters with multiple entries.
FilterPorts List<string>
Up to 16 comma-separated ports used as a filter. A list of predefined port names is also available, like ssh and telnet.
FilterSize string
Filters packets of specified size or size range in bytes.
FilterSrcIpAddresses List<string>
Up to 16 IP source addresses used as a filter.
FilterSrcIpv6Addresses List<string>
Up to 16 IPv6 source addresses used as a filter.
FilterSrcMacAddresses List<string>
Up to 16 MAC source addresses and MAC address masks used as a filter.
FilterSrcPorts List<string>
Up to 16 comma-separated source ports used as a filter. A list of predefined port names is also available, like ssh and telnet.
FilterStream bool
Sniffed packets that are devised for the sniffer server are ignored.
FilterVlans List<double>
Up to 16 VLAN IDs used as a filter.
MemoryLimit double
Memory amount used to store sniffed data.
MemoryScroll bool
Whether to rewrite older sniffed data when the memory limit is reached.
OnlyHeaders bool
Save in the memory only the packet's headers, not the whole packet.
Running bool
StreamingEnabled bool
Defines whether to send sniffed packets to the streaming server.
StreamingServer string
Tazmen Sniffer Protocol (TZSP) stream receiver.
ToolSnifferId string
___id_ double
Resource ID type (.id / name). This is an internal service field, setting a value is not required.
___path_ string
Resource path for CRUD operations. This is an internal service field, setting a value is not required.
___skip_ string
A set of transformations for field names. This is an internal service field, setting a value is not required.
Enabled bool
Start packet capture.
FileLimit float64
File size limit. Sniffer will stop when a limit is reached.
FileName string
Name of the file where sniffed packets will be saved.
FilterCpu string
CPU core used as a filter.
FilterDirection string
Specifies which direction filtering will be applied.
FilterDstIpAddresses []string
Up to 16 IP destination addresses used as a filter.
FilterDstIpv6Addresses []string
Up to 16 IPv6 destination addresses used as a filter.
FilterDstMacAddresses []string
Up to 16 MAC destination addresses and MAC address masks used as a filter.
FilterDstPorts []string
Up to 16 comma-separated destination ports used as a filter. A list of predefined port names is also available, like ssh and telnet.
FilterInterfaces []string
Interface name on which sniffer will be running. all indicates that the sniffer will sniff packets on all interfaces.
FilterIpAddresses []string
Up to 16 IP addresses used as a filter.
FilterIpProtocols []string
Up to 16 comma-separated IP/IPv6 protocols used as a filter. IP protocols (instead of protocol names, protocol numbers can be used): * ipsec-ah - IPsec AH protocol * ipsec-esp - IPsec ESP protocol * ddp - datagram delivery protocol * egp - exterior gateway protocol * ggp - gateway-gateway protocol * gre - general routing encapsulation * hmp - host monitoring protocol * idpr-cmtp - idpr control message transport * icmp - internet control message protocol * icmpv6 - internet control message protocol v6 * igmp - internet group management protocol * ipencap - ip encapsulated in ip * ipip - ip encapsulation * encap - ip encapsulation * iso-tp4 - iso transport protocol class 4 * ospf - open shortest path first * pup - parc universal packet protocol * pim - protocol independent multicast * rspf - radio shortest path first * rdp - reliable datagram protocol * st - st datagram mode * tcp - transmission control protocol * udp - user datagram protocol

  • vmtp versatile message transport * vrrp - virtual router redundancy protocol * xns-idp - xerox xns idp * xtp - xpress transfer protocol
FilterIpv6Addresses []string
Up to 16 IPv6 addresses used as a filter.
FilterMacAddresses []string
Up to 16 MAC addresses and MAC address masks used as a filter.
FilterMacProtocols []string
Up to 16 comma separated entries used as a filter. Mac protocols (instead of protocol names, protocol number can be used): * 802.2 - 802.2 Frames (0x0004) * arp - Address Resolution Protocol (0x0806) * homeplug-av - HomePlug AV MME (0x88E1) * ip - Internet Protocol version 4 (0x0800) * ipv6 - Internet Protocol Version 6 (0x86DD) * ipx - Internetwork Packet Exchange (0x8137) * lldp - Link Layer Discovery Protocol (0x88CC) * loop-protect - Loop Protect Protocol (0x9003)

  • mpls-multicast - MPLS multicast (0x8848) * mpls-unicast - MPLS unicast (0x8847) * packing-compr - Encapsulated packets with compressed IP packing (0x9001) * packing-simple - Encapsulated packets with simple IP packing (0x9000) * pppoe - PPPoE Session Stage (0x8864) * pppoe-discovery - PPPoE Discovery Stage (0x8863) * rarp - Reverse Address Resolution Protocol (0x8035) * service-vlan - Provider Bridging (IEEE 802.1ad) & Shortest Path Bridging IEEE 802.1aq (0x88A8) * vlan - VLAN-tagged frame (IEEE 802.1Q) and Shortest Path Bridging IEEE 802.1aq with NNI compatibility (0x8100)
FilterOperatorBetweenEntries string
Changes the logic for filters with multiple entries.
FilterPorts []string
Up to 16 comma-separated ports used as a filter. A list of predefined port names is also available, like ssh and telnet.
FilterSize string
Filters packets of specified size or size range in bytes.
FilterSrcIpAddresses []string
Up to 16 IP source addresses used as a filter.
FilterSrcIpv6Addresses []string
Up to 16 IPv6 source addresses used as a filter.
FilterSrcMacAddresses []string
Up to 16 MAC source addresses and MAC address masks used as a filter.
FilterSrcPorts []string
Up to 16 comma-separated source ports used as a filter. A list of predefined port names is also available, like ssh and telnet.
FilterStream bool
Sniffed packets that are devised for the sniffer server are ignored.
FilterVlans []float64
Up to 16 VLAN IDs used as a filter.
MemoryLimit float64
Memory amount used to store sniffed data.
MemoryScroll bool
Whether to rewrite older sniffed data when the memory limit is reached.
OnlyHeaders bool
Save in the memory only the packet's headers, not the whole packet.
Running bool
StreamingEnabled bool
Defines whether to send sniffed packets to the streaming server.
StreamingServer string
Tazmen Sniffer Protocol (TZSP) stream receiver.
ToolSnifferId string
___id_ float64
Resource ID type (.id / name). This is an internal service field, setting a value is not required.
___path_ string
Resource path for CRUD operations. This is an internal service field, setting a value is not required.
___skip_ string
A set of transformations for field names. This is an internal service field, setting a value is not required.
___id_ Double
Resource ID type (.id / name). This is an internal service field, setting a value is not required.
___path_ String
Resource path for CRUD operations. This is an internal service field, setting a value is not required.
___skip_ String
A set of transformations for field names. This is an internal service field, setting a value is not required.
enabled Boolean
Start packet capture.
fileLimit Double
File size limit. Sniffer will stop when a limit is reached.
fileName String
Name of the file where sniffed packets will be saved.
filterCpu String
CPU core used as a filter.
filterDirection String
Specifies which direction filtering will be applied.
filterDstIpAddresses List<String>
Up to 16 IP destination addresses used as a filter.
filterDstIpv6Addresses List<String>
Up to 16 IPv6 destination addresses used as a filter.
filterDstMacAddresses List<String>
Up to 16 MAC destination addresses and MAC address masks used as a filter.
filterDstPorts List<String>
Up to 16 comma-separated destination ports used as a filter. A list of predefined port names is also available, like ssh and telnet.
filterInterfaces List<String>
Interface name on which sniffer will be running. all indicates that the sniffer will sniff packets on all interfaces.
filterIpAddresses List<String>
Up to 16 IP addresses used as a filter.
filterIpProtocols List<String>
Up to 16 comma-separated IP/IPv6 protocols used as a filter. IP protocols (instead of protocol names, protocol numbers can be used): * ipsec-ah - IPsec AH protocol * ipsec-esp - IPsec ESP protocol * ddp - datagram delivery protocol * egp - exterior gateway protocol * ggp - gateway-gateway protocol * gre - general routing encapsulation * hmp - host monitoring protocol * idpr-cmtp - idpr control message transport * icmp - internet control message protocol * icmpv6 - internet control message protocol v6 * igmp - internet group management protocol * ipencap - ip encapsulated in ip * ipip - ip encapsulation * encap - ip encapsulation * iso-tp4 - iso transport protocol class 4 * ospf - open shortest path first * pup - parc universal packet protocol * pim - protocol independent multicast * rspf - radio shortest path first * rdp - reliable datagram protocol * st - st datagram mode * tcp - transmission control protocol * udp - user datagram protocol

  • vmtp versatile message transport * vrrp - virtual router redundancy protocol * xns-idp - xerox xns idp * xtp - xpress transfer protocol
filterIpv6Addresses List<String>
Up to 16 IPv6 addresses used as a filter.
filterMacAddresses List<String>
Up to 16 MAC addresses and MAC address masks used as a filter.
filterMacProtocols List<String>
Up to 16 comma separated entries used as a filter. Mac protocols (instead of protocol names, protocol number can be used): * 802.2 - 802.2 Frames (0x0004) * arp - Address Resolution Protocol (0x0806) * homeplug-av - HomePlug AV MME (0x88E1) * ip - Internet Protocol version 4 (0x0800) * ipv6 - Internet Protocol Version 6 (0x86DD) * ipx - Internetwork Packet Exchange (0x8137) * lldp - Link Layer Discovery Protocol (0x88CC) * loop-protect - Loop Protect Protocol (0x9003)

  • mpls-multicast - MPLS multicast (0x8848) * mpls-unicast - MPLS unicast (0x8847) * packing-compr - Encapsulated packets with compressed IP packing (0x9001) * packing-simple - Encapsulated packets with simple IP packing (0x9000) * pppoe - PPPoE Session Stage (0x8864) * pppoe-discovery - PPPoE Discovery Stage (0x8863) * rarp - Reverse Address Resolution Protocol (0x8035) * service-vlan - Provider Bridging (IEEE 802.1ad) & Shortest Path Bridging IEEE 802.1aq (0x88A8) * vlan - VLAN-tagged frame (IEEE 802.1Q) and Shortest Path Bridging IEEE 802.1aq with NNI compatibility (0x8100)
filterOperatorBetweenEntries String
Changes the logic for filters with multiple entries.
filterPorts List<String>
Up to 16 comma-separated ports used as a filter. A list of predefined port names is also available, like ssh and telnet.
filterSize String
Filters packets of specified size or size range in bytes.
filterSrcIpAddresses List<String>
Up to 16 IP source addresses used as a filter.
filterSrcIpv6Addresses List<String>
Up to 16 IPv6 source addresses used as a filter.
filterSrcMacAddresses List<String>
Up to 16 MAC source addresses and MAC address masks used as a filter.
filterSrcPorts List<String>
Up to 16 comma-separated source ports used as a filter. A list of predefined port names is also available, like ssh and telnet.
filterStream Boolean
Sniffed packets that are devised for the sniffer server are ignored.
filterVlans List<Double>
Up to 16 VLAN IDs used as a filter.
memoryLimit Double
Memory amount used to store sniffed data.
memoryScroll Boolean
Whether to rewrite older sniffed data when the memory limit is reached.
onlyHeaders Boolean
Save in the memory only the packet's headers, not the whole packet.
running Boolean
streamingEnabled Boolean
Defines whether to send sniffed packets to the streaming server.
streamingServer String
Tazmen Sniffer Protocol (TZSP) stream receiver.
toolSnifferId String
___id_ number
Resource ID type (.id / name). This is an internal service field, setting a value is not required.
___path_ string
Resource path for CRUD operations. This is an internal service field, setting a value is not required.
___skip_ string
A set of transformations for field names. This is an internal service field, setting a value is not required.
enabled boolean
Start packet capture.
fileLimit number
File size limit. Sniffer will stop when a limit is reached.
fileName string
Name of the file where sniffed packets will be saved.
filterCpu string
CPU core used as a filter.
filterDirection string
Specifies which direction filtering will be applied.
filterDstIpAddresses string[]
Up to 16 IP destination addresses used as a filter.
filterDstIpv6Addresses string[]
Up to 16 IPv6 destination addresses used as a filter.
filterDstMacAddresses string[]
Up to 16 MAC destination addresses and MAC address masks used as a filter.
filterDstPorts string[]
Up to 16 comma-separated destination ports used as a filter. A list of predefined port names is also available, like ssh and telnet.
filterInterfaces string[]
Interface name on which sniffer will be running. all indicates that the sniffer will sniff packets on all interfaces.
filterIpAddresses string[]
Up to 16 IP addresses used as a filter.
filterIpProtocols string[]
Up to 16 comma-separated IP/IPv6 protocols used as a filter. IP protocols (instead of protocol names, protocol numbers can be used): * ipsec-ah - IPsec AH protocol * ipsec-esp - IPsec ESP protocol * ddp - datagram delivery protocol * egp - exterior gateway protocol * ggp - gateway-gateway protocol * gre - general routing encapsulation * hmp - host monitoring protocol * idpr-cmtp - idpr control message transport * icmp - internet control message protocol * icmpv6 - internet control message protocol v6 * igmp - internet group management protocol * ipencap - ip encapsulated in ip * ipip - ip encapsulation * encap - ip encapsulation * iso-tp4 - iso transport protocol class 4 * ospf - open shortest path first * pup - parc universal packet protocol * pim - protocol independent multicast * rspf - radio shortest path first * rdp - reliable datagram protocol * st - st datagram mode * tcp - transmission control protocol * udp - user datagram protocol

  • vmtp versatile message transport * vrrp - virtual router redundancy protocol * xns-idp - xerox xns idp * xtp - xpress transfer protocol
filterIpv6Addresses string[]
Up to 16 IPv6 addresses used as a filter.
filterMacAddresses string[]
Up to 16 MAC addresses and MAC address masks used as a filter.
filterMacProtocols string[]
Up to 16 comma separated entries used as a filter. Mac protocols (instead of protocol names, protocol number can be used): * 802.2 - 802.2 Frames (0x0004) * arp - Address Resolution Protocol (0x0806) * homeplug-av - HomePlug AV MME (0x88E1) * ip - Internet Protocol version 4 (0x0800) * ipv6 - Internet Protocol Version 6 (0x86DD) * ipx - Internetwork Packet Exchange (0x8137) * lldp - Link Layer Discovery Protocol (0x88CC) * loop-protect - Loop Protect Protocol (0x9003)

  • mpls-multicast - MPLS multicast (0x8848) * mpls-unicast - MPLS unicast (0x8847) * packing-compr - Encapsulated packets with compressed IP packing (0x9001) * packing-simple - Encapsulated packets with simple IP packing (0x9000) * pppoe - PPPoE Session Stage (0x8864) * pppoe-discovery - PPPoE Discovery Stage (0x8863) * rarp - Reverse Address Resolution Protocol (0x8035) * service-vlan - Provider Bridging (IEEE 802.1ad) & Shortest Path Bridging IEEE 802.1aq (0x88A8) * vlan - VLAN-tagged frame (IEEE 802.1Q) and Shortest Path Bridging IEEE 802.1aq with NNI compatibility (0x8100)
filterOperatorBetweenEntries string
Changes the logic for filters with multiple entries.
filterPorts string[]
Up to 16 comma-separated ports used as a filter. A list of predefined port names is also available, like ssh and telnet.
filterSize string
Filters packets of specified size or size range in bytes.
filterSrcIpAddresses string[]
Up to 16 IP source addresses used as a filter.
filterSrcIpv6Addresses string[]
Up to 16 IPv6 source addresses used as a filter.
filterSrcMacAddresses string[]
Up to 16 MAC source addresses and MAC address masks used as a filter.
filterSrcPorts string[]
Up to 16 comma-separated source ports used as a filter. A list of predefined port names is also available, like ssh and telnet.
filterStream boolean
Sniffed packets that are devised for the sniffer server are ignored.
filterVlans number[]
Up to 16 VLAN IDs used as a filter.
memoryLimit number
Memory amount used to store sniffed data.
memoryScroll boolean
Whether to rewrite older sniffed data when the memory limit is reached.
onlyHeaders boolean
Save in the memory only the packet's headers, not the whole packet.
running boolean
streamingEnabled boolean
Defines whether to send sniffed packets to the streaming server.
streamingServer string
Tazmen Sniffer Protocol (TZSP) stream receiver.
toolSnifferId string
___id_ float
Resource ID type (.id / name). This is an internal service field, setting a value is not required.
___path_ str
Resource path for CRUD operations. This is an internal service field, setting a value is not required.
___skip_ str
A set of transformations for field names. This is an internal service field, setting a value is not required.
enabled bool
Start packet capture.
file_limit float
File size limit. Sniffer will stop when a limit is reached.
file_name str
Name of the file where sniffed packets will be saved.
filter_cpu str
CPU core used as a filter.
filter_direction str
Specifies which direction filtering will be applied.
filter_dst_ip_addresses Sequence[str]
Up to 16 IP destination addresses used as a filter.
filter_dst_ipv6_addresses Sequence[str]
Up to 16 IPv6 destination addresses used as a filter.
filter_dst_mac_addresses Sequence[str]
Up to 16 MAC destination addresses and MAC address masks used as a filter.
filter_dst_ports Sequence[str]
Up to 16 comma-separated destination ports used as a filter. A list of predefined port names is also available, like ssh and telnet.
filter_interfaces Sequence[str]
Interface name on which sniffer will be running. all indicates that the sniffer will sniff packets on all interfaces.
filter_ip_addresses Sequence[str]
Up to 16 IP addresses used as a filter.
filter_ip_protocols Sequence[str]
Up to 16 comma-separated IP/IPv6 protocols used as a filter. IP protocols (instead of protocol names, protocol numbers can be used): * ipsec-ah - IPsec AH protocol * ipsec-esp - IPsec ESP protocol * ddp - datagram delivery protocol * egp - exterior gateway protocol * ggp - gateway-gateway protocol * gre - general routing encapsulation * hmp - host monitoring protocol * idpr-cmtp - idpr control message transport * icmp - internet control message protocol * icmpv6 - internet control message protocol v6 * igmp - internet group management protocol * ipencap - ip encapsulated in ip * ipip - ip encapsulation * encap - ip encapsulation * iso-tp4 - iso transport protocol class 4 * ospf - open shortest path first * pup - parc universal packet protocol * pim - protocol independent multicast * rspf - radio shortest path first * rdp - reliable datagram protocol * st - st datagram mode * tcp - transmission control protocol * udp - user datagram protocol

  • vmtp versatile message transport * vrrp - virtual router redundancy protocol * xns-idp - xerox xns idp * xtp - xpress transfer protocol
filter_ipv6_addresses Sequence[str]
Up to 16 IPv6 addresses used as a filter.
filter_mac_addresses Sequence[str]
Up to 16 MAC addresses and MAC address masks used as a filter.
filter_mac_protocols Sequence[str]
Up to 16 comma separated entries used as a filter. Mac protocols (instead of protocol names, protocol number can be used): * 802.2 - 802.2 Frames (0x0004) * arp - Address Resolution Protocol (0x0806) * homeplug-av - HomePlug AV MME (0x88E1) * ip - Internet Protocol version 4 (0x0800) * ipv6 - Internet Protocol Version 6 (0x86DD) * ipx - Internetwork Packet Exchange (0x8137) * lldp - Link Layer Discovery Protocol (0x88CC) * loop-protect - Loop Protect Protocol (0x9003)

  • mpls-multicast - MPLS multicast (0x8848) * mpls-unicast - MPLS unicast (0x8847) * packing-compr - Encapsulated packets with compressed IP packing (0x9001) * packing-simple - Encapsulated packets with simple IP packing (0x9000) * pppoe - PPPoE Session Stage (0x8864) * pppoe-discovery - PPPoE Discovery Stage (0x8863) * rarp - Reverse Address Resolution Protocol (0x8035) * service-vlan - Provider Bridging (IEEE 802.1ad) & Shortest Path Bridging IEEE 802.1aq (0x88A8) * vlan - VLAN-tagged frame (IEEE 802.1Q) and Shortest Path Bridging IEEE 802.1aq with NNI compatibility (0x8100)
filter_operator_between_entries str
Changes the logic for filters with multiple entries.
filter_ports Sequence[str]
Up to 16 comma-separated ports used as a filter. A list of predefined port names is also available, like ssh and telnet.
filter_size str
Filters packets of specified size or size range in bytes.
filter_src_ip_addresses Sequence[str]
Up to 16 IP source addresses used as a filter.
filter_src_ipv6_addresses Sequence[str]
Up to 16 IPv6 source addresses used as a filter.
filter_src_mac_addresses Sequence[str]
Up to 16 MAC source addresses and MAC address masks used as a filter.
filter_src_ports Sequence[str]
Up to 16 comma-separated source ports used as a filter. A list of predefined port names is also available, like ssh and telnet.
filter_stream bool
Sniffed packets that are devised for the sniffer server are ignored.
filter_vlans Sequence[float]
Up to 16 VLAN IDs used as a filter.
memory_limit float
Memory amount used to store sniffed data.
memory_scroll bool
Whether to rewrite older sniffed data when the memory limit is reached.
only_headers bool
Save in the memory only the packet's headers, not the whole packet.
running bool
streaming_enabled bool
Defines whether to send sniffed packets to the streaming server.
streaming_server str
Tazmen Sniffer Protocol (TZSP) stream receiver.
tool_sniffer_id str
___id_ Number
Resource ID type (.id / name). This is an internal service field, setting a value is not required.
___path_ String
Resource path for CRUD operations. This is an internal service field, setting a value is not required.
___skip_ String
A set of transformations for field names. This is an internal service field, setting a value is not required.
enabled Boolean
Start packet capture.
fileLimit Number
File size limit. Sniffer will stop when a limit is reached.
fileName String
Name of the file where sniffed packets will be saved.
filterCpu String
CPU core used as a filter.
filterDirection String
Specifies which direction filtering will be applied.
filterDstIpAddresses List<String>
Up to 16 IP destination addresses used as a filter.
filterDstIpv6Addresses List<String>
Up to 16 IPv6 destination addresses used as a filter.
filterDstMacAddresses List<String>
Up to 16 MAC destination addresses and MAC address masks used as a filter.
filterDstPorts List<String>
Up to 16 comma-separated destination ports used as a filter. A list of predefined port names is also available, like ssh and telnet.
filterInterfaces List<String>
Interface name on which sniffer will be running. all indicates that the sniffer will sniff packets on all interfaces.
filterIpAddresses List<String>
Up to 16 IP addresses used as a filter.
filterIpProtocols List<String>
Up to 16 comma-separated IP/IPv6 protocols used as a filter. IP protocols (instead of protocol names, protocol numbers can be used): * ipsec-ah - IPsec AH protocol * ipsec-esp - IPsec ESP protocol * ddp - datagram delivery protocol * egp - exterior gateway protocol * ggp - gateway-gateway protocol * gre - general routing encapsulation * hmp - host monitoring protocol * idpr-cmtp - idpr control message transport * icmp - internet control message protocol * icmpv6 - internet control message protocol v6 * igmp - internet group management protocol * ipencap - ip encapsulated in ip * ipip - ip encapsulation * encap - ip encapsulation * iso-tp4 - iso transport protocol class 4 * ospf - open shortest path first * pup - parc universal packet protocol * pim - protocol independent multicast * rspf - radio shortest path first * rdp - reliable datagram protocol * st - st datagram mode * tcp - transmission control protocol * udp - user datagram protocol

  • vmtp versatile message transport * vrrp - virtual router redundancy protocol * xns-idp - xerox xns idp * xtp - xpress transfer protocol
filterIpv6Addresses List<String>
Up to 16 IPv6 addresses used as a filter.
filterMacAddresses List<String>
Up to 16 MAC addresses and MAC address masks used as a filter.
filterMacProtocols List<String>
Up to 16 comma separated entries used as a filter. Mac protocols (instead of protocol names, protocol number can be used): * 802.2 - 802.2 Frames (0x0004) * arp - Address Resolution Protocol (0x0806) * homeplug-av - HomePlug AV MME (0x88E1) * ip - Internet Protocol version 4 (0x0800) * ipv6 - Internet Protocol Version 6 (0x86DD) * ipx - Internetwork Packet Exchange (0x8137) * lldp - Link Layer Discovery Protocol (0x88CC) * loop-protect - Loop Protect Protocol (0x9003)

  • mpls-multicast - MPLS multicast (0x8848) * mpls-unicast - MPLS unicast (0x8847) * packing-compr - Encapsulated packets with compressed IP packing (0x9001) * packing-simple - Encapsulated packets with simple IP packing (0x9000) * pppoe - PPPoE Session Stage (0x8864) * pppoe-discovery - PPPoE Discovery Stage (0x8863) * rarp - Reverse Address Resolution Protocol (0x8035) * service-vlan - Provider Bridging (IEEE 802.1ad) & Shortest Path Bridging IEEE 802.1aq (0x88A8) * vlan - VLAN-tagged frame (IEEE 802.1Q) and Shortest Path Bridging IEEE 802.1aq with NNI compatibility (0x8100)
filterOperatorBetweenEntries String
Changes the logic for filters with multiple entries.
filterPorts List<String>
Up to 16 comma-separated ports used as a filter. A list of predefined port names is also available, like ssh and telnet.
filterSize String
Filters packets of specified size or size range in bytes.
filterSrcIpAddresses List<String>
Up to 16 IP source addresses used as a filter.
filterSrcIpv6Addresses List<String>
Up to 16 IPv6 source addresses used as a filter.
filterSrcMacAddresses List<String>
Up to 16 MAC source addresses and MAC address masks used as a filter.
filterSrcPorts List<String>
Up to 16 comma-separated source ports used as a filter. A list of predefined port names is also available, like ssh and telnet.
filterStream Boolean
Sniffed packets that are devised for the sniffer server are ignored.
filterVlans List<Number>
Up to 16 VLAN IDs used as a filter.
memoryLimit Number
Memory amount used to store sniffed data.
memoryScroll Boolean
Whether to rewrite older sniffed data when the memory limit is reached.
onlyHeaders Boolean
Save in the memory only the packet's headers, not the whole packet.
running Boolean
streamingEnabled Boolean
Defines whether to send sniffed packets to the streaming server.
streamingServer String
Tazmen Sniffer Protocol (TZSP) stream receiver.
toolSnifferId String

Import

$ pulumi import routeros:index/toolSniffer:ToolSniffer test .
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
routeros terraform-routeros/terraform-provider-routeros
License
Notes
This Pulumi package is based on the routeros Terraform Provider.
routeros 1.83.0 published on Wednesday, Apr 16, 2025 by terraform-routeros
terraform-routeros/terraform-provider-routeros