Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Fortimanager Provider
  3. API Docs
  4. SystemSniffer
fortimanager 1.13.0 published on Thursday, Mar 13, 2025 by fortinetdev
fortinetdev/terraform-provider-fortimanager

fortimanager.SystemSniffer

Explore with Pulumi AI

fortimanager logo
fortimanager 1.13.0 published on Thursday, Mar 13, 2025 by fortinetdev
fortinetdev/terraform-provider-fortimanager

    Interface sniffer.

    Example Usage

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

const trname = new fortimanager.SystemSniffer("trname", {
    fosid: 1,
    "interface": "port5",
    ipv6: "disable",
    protocol: "20",
    vlan: "100",
});

    import pulumi
import pulumi_fortimanager as fortimanager

trname = fortimanager.SystemSniffer("trname",
    fosid=1,
    interface="port5",
    ipv6="disable",
    protocol="20",
    vlan="100")

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := fortimanager.NewSystemSniffer(ctx, "trname", &fortimanager.SystemSnifferArgs{
			Fosid:     pulumi.Float64(1),
			Interface: pulumi.String("port5"),
			Ipv6:      pulumi.String("disable"),
			Protocol:  pulumi.String("20"),
			Vlan:      pulumi.String("100"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Fortimanager = Pulumi.Fortimanager;

return await Deployment.RunAsync(() => 
{
    var trname = new Fortimanager.SystemSniffer("trname", new()
    {
        Fosid = 1,
        Interface = "port5",
        Ipv6 = "disable",
        Protocol = "20",
        Vlan = "100",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.fortimanager.SystemSniffer;
import com.pulumi.fortimanager.SystemSnifferArgs;
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 trname = new SystemSniffer("trname", SystemSnifferArgs.builder()
            .fosid("1")
            .interface_("port5")
            .ipv6("disable")
            .protocol("20")
            .vlan("100")
            .build());

    }
}

    resources:
  trname:
    type: fortimanager:SystemSniffer
    properties:
      fosid: '1'
      interface: port5
      ipv6: disable
      protocol: '20'
      vlan: '100'

    Create SystemSniffer Resource

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

    Constructor syntax

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

@overload
def SystemSniffer(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  fosid: Optional[float] = None,
                  host: Optional[str] = None,
                  interface: Optional[str] = None,
                  ipv6: Optional[str] = None,
                  max_packet_count: Optional[float] = None,
                  non_ip: Optional[str] = None,
                  port: Optional[str] = None,
                  protocol: Optional[str] = None,
                  system_sniffer_id: Optional[str] = None,
                  vlan: Optional[str] = None)
    func NewSystemSniffer(ctx *Context, name string, args *SystemSnifferArgs, opts ...ResourceOption) (*SystemSniffer, error)
    public SystemSniffer(string name, SystemSnifferArgs? args = null, CustomResourceOptions? opts = null)
    public SystemSniffer(String name, SystemSnifferArgs args)
public SystemSniffer(String name, SystemSnifferArgs args, CustomResourceOptions options)

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

    Parameters

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

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var systemSnifferResource = new Fortimanager.SystemSniffer("systemSnifferResource", new()
{
    Fosid = 0,
    Host = "string",
    Interface = "string",
    Ipv6 = "string",
    MaxPacketCount = 0,
    NonIp = "string",
    Port = "string",
    Protocol = "string",
    SystemSnifferId = "string",
    Vlan = "string",
});

    example, err := fortimanager.NewSystemSniffer(ctx, "systemSnifferResource", &fortimanager.SystemSnifferArgs{
Fosid: pulumi.Float64(0),
Host: pulumi.String("string"),
Interface: pulumi.String("string"),
Ipv6: pulumi.String("string"),
MaxPacketCount: pulumi.Float64(0),
NonIp: pulumi.String("string"),
Port: pulumi.String("string"),
Protocol: pulumi.String("string"),
SystemSnifferId: pulumi.String("string"),
Vlan: pulumi.String("string"),
})

    var systemSnifferResource = new SystemSniffer("systemSnifferResource", SystemSnifferArgs.builder()
    .fosid(0)
    .host("string")
    .interface_("string")
    .ipv6("string")
    .maxPacketCount(0)
    .nonIp("string")
    .port("string")
    .protocol("string")
    .systemSnifferId("string")
    .vlan("string")
    .build());

    system_sniffer_resource = fortimanager.SystemSniffer("systemSnifferResource",
    fosid=0,
    host="string",
    interface="string",
    ipv6="string",
    max_packet_count=0,
    non_ip="string",
    port="string",
    protocol="string",
    system_sniffer_id="string",
    vlan="string")

    const systemSnifferResource = new fortimanager.SystemSniffer("systemSnifferResource", {
    fosid: 0,
    host: "string",
    "interface": "string",
    ipv6: "string",
    maxPacketCount: 0,
    nonIp: "string",
    port: "string",
    protocol: "string",
    systemSnifferId: "string",
    vlan: "string",
});

    type: fortimanager:SystemSniffer
properties:
    fosid: 0
    host: string
    interface: string
    ipv6: string
    maxPacketCount: 0
    nonIp: string
    port: string
    protocol: string
    systemSnifferId: string
    vlan: string

    SystemSniffer 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 SystemSniffer resource accepts the following input properties:

    Fosid double
    Sniffer ID.
    Host string
    Hosts to filter for in sniffer traffic
    Interface string
    Interface.
    Ipv6 string
    Enable/disable sniffing IPv6 packets. disable - Disable sniffer for IPv6 packets. enable - Enable sniffer for IPv6 packets. Valid values: disable, enable.
    MaxPacketCount double
    Maximum packet count (1000000, default = 4000).
    NonIp string
    Enable/disable sniffing non-IP packets. disable - Disable sniffer for non-IP packets. enable - Enable sniffer for non-IP packets. Valid values: disable, enable.
    Port string
    Ports to sniff (Format examples: 10, 100-200).
    Protocol string
    Integer value for the protocol type as defined by IANA (0 - 255).
    SystemSnifferId string
    an identifier for the resource with format {{fosid}}.
    Vlan string
    List of VLANs to sniff.
    Fosid float64
    Sniffer ID.
    Host string
    Hosts to filter for in sniffer traffic
    Interface string
    Interface.
    Ipv6 string
    Enable/disable sniffing IPv6 packets. disable - Disable sniffer for IPv6 packets. enable - Enable sniffer for IPv6 packets. Valid values: disable, enable.
    MaxPacketCount float64
    Maximum packet count (1000000, default = 4000).
    NonIp string
    Enable/disable sniffing non-IP packets. disable - Disable sniffer for non-IP packets. enable - Enable sniffer for non-IP packets. Valid values: disable, enable.
    Port string
    Ports to sniff (Format examples: 10, 100-200).
    Protocol string
    Integer value for the protocol type as defined by IANA (0 - 255).
    SystemSnifferId string
    an identifier for the resource with format {{fosid}}.
    Vlan string
    List of VLANs to sniff.
    fosid Double
    Sniffer ID.
    host String
    Hosts to filter for in sniffer traffic
    interface_ String
    Interface.
    ipv6 String
    Enable/disable sniffing IPv6 packets. disable - Disable sniffer for IPv6 packets. enable - Enable sniffer for IPv6 packets. Valid values: disable, enable.
    maxPacketCount Double
    Maximum packet count (1000000, default = 4000).
    nonIp String
    Enable/disable sniffing non-IP packets. disable - Disable sniffer for non-IP packets. enable - Enable sniffer for non-IP packets. Valid values: disable, enable.
    port String
    Ports to sniff (Format examples: 10, 100-200).
    protocol String
    Integer value for the protocol type as defined by IANA (0 - 255).
    systemSnifferId String
    an identifier for the resource with format {{fosid}}.
    vlan String
    List of VLANs to sniff.
    fosid number
    Sniffer ID.
    host string
    Hosts to filter for in sniffer traffic
    interface string
    Interface.
    ipv6 string
    Enable/disable sniffing IPv6 packets. disable - Disable sniffer for IPv6 packets. enable - Enable sniffer for IPv6 packets. Valid values: disable, enable.
    maxPacketCount number
    Maximum packet count (1000000, default = 4000).
    nonIp string
    Enable/disable sniffing non-IP packets. disable - Disable sniffer for non-IP packets. enable - Enable sniffer for non-IP packets. Valid values: disable, enable.
    port string
    Ports to sniff (Format examples: 10, 100-200).
    protocol string
    Integer value for the protocol type as defined by IANA (0 - 255).
    systemSnifferId string
    an identifier for the resource with format {{fosid}}.
    vlan string
    List of VLANs to sniff.
    fosid float
    Sniffer ID.
    host str
    Hosts to filter for in sniffer traffic
    interface str
    Interface.
    ipv6 str
    Enable/disable sniffing IPv6 packets. disable - Disable sniffer for IPv6 packets. enable - Enable sniffer for IPv6 packets. Valid values: disable, enable.
    max_packet_count float
    Maximum packet count (1000000, default = 4000).
    non_ip str
    Enable/disable sniffing non-IP packets. disable - Disable sniffer for non-IP packets. enable - Enable sniffer for non-IP packets. Valid values: disable, enable.
    port str
    Ports to sniff (Format examples: 10, 100-200).
    protocol str
    Integer value for the protocol type as defined by IANA (0 - 255).
    system_sniffer_id str
    an identifier for the resource with format {{fosid}}.
    vlan str
    List of VLANs to sniff.
    fosid Number
    Sniffer ID.
    host String
    Hosts to filter for in sniffer traffic
    interface String
    Interface.
    ipv6 String
    Enable/disable sniffing IPv6 packets. disable - Disable sniffer for IPv6 packets. enable - Enable sniffer for IPv6 packets. Valid values: disable, enable.
    maxPacketCount Number
    Maximum packet count (1000000, default = 4000).
    nonIp String
    Enable/disable sniffing non-IP packets. disable - Disable sniffer for non-IP packets. enable - Enable sniffer for non-IP packets. Valid values: disable, enable.
    port String
    Ports to sniff (Format examples: 10, 100-200).
    protocol String
    Integer value for the protocol type as defined by IANA (0 - 255).
    systemSnifferId String
    an identifier for the resource with format {{fosid}}.
    vlan String
    List of VLANs to sniff.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing SystemSniffer Resource

    Get an existing SystemSniffer 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?: SystemSnifferState, opts?: CustomResourceOptions): SystemSniffer
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        fosid: Optional[float] = None,
        host: Optional[str] = None,
        interface: Optional[str] = None,
        ipv6: Optional[str] = None,
        max_packet_count: Optional[float] = None,
        non_ip: Optional[str] = None,
        port: Optional[str] = None,
        protocol: Optional[str] = None,
        system_sniffer_id: Optional[str] = None,
        vlan: Optional[str] = None) -> SystemSniffer
    func GetSystemSniffer(ctx *Context, name string, id IDInput, state *SystemSnifferState, opts ...ResourceOption) (*SystemSniffer, error)
    public static SystemSniffer Get(string name, Input<string> id, SystemSnifferState? state, CustomResourceOptions? opts = null)
    public static SystemSniffer get(String name, Output<String> id, SystemSnifferState state, CustomResourceOptions options)
    resources:  _:    type: fortimanager:SystemSniffer    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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:
    Fosid double
    Sniffer ID.
    Host string
    Hosts to filter for in sniffer traffic
    Interface string
    Interface.
    Ipv6 string
    Enable/disable sniffing IPv6 packets. disable - Disable sniffer for IPv6 packets. enable - Enable sniffer for IPv6 packets. Valid values: disable, enable.
    MaxPacketCount double
    Maximum packet count (1000000, default = 4000).
    NonIp string
    Enable/disable sniffing non-IP packets. disable - Disable sniffer for non-IP packets. enable - Enable sniffer for non-IP packets. Valid values: disable, enable.
    Port string
    Ports to sniff (Format examples: 10, 100-200).
    Protocol string
    Integer value for the protocol type as defined by IANA (0 - 255).
    SystemSnifferId string
    an identifier for the resource with format {{fosid}}.
    Vlan string
    List of VLANs to sniff.
    Fosid float64
    Sniffer ID.
    Host string
    Hosts to filter for in sniffer traffic
    Interface string
    Interface.
    Ipv6 string
    Enable/disable sniffing IPv6 packets. disable - Disable sniffer for IPv6 packets. enable - Enable sniffer for IPv6 packets. Valid values: disable, enable.
    MaxPacketCount float64
    Maximum packet count (1000000, default = 4000).
    NonIp string
    Enable/disable sniffing non-IP packets. disable - Disable sniffer for non-IP packets. enable - Enable sniffer for non-IP packets. Valid values: disable, enable.
    Port string
    Ports to sniff (Format examples: 10, 100-200).
    Protocol string
    Integer value for the protocol type as defined by IANA (0 - 255).
    SystemSnifferId string
    an identifier for the resource with format {{fosid}}.
    Vlan string
    List of VLANs to sniff.
    fosid Double
    Sniffer ID.
    host String
    Hosts to filter for in sniffer traffic
    interface_ String
    Interface.
    ipv6 String
    Enable/disable sniffing IPv6 packets. disable - Disable sniffer for IPv6 packets. enable - Enable sniffer for IPv6 packets. Valid values: disable, enable.
    maxPacketCount Double
    Maximum packet count (1000000, default = 4000).
    nonIp String
    Enable/disable sniffing non-IP packets. disable - Disable sniffer for non-IP packets. enable - Enable sniffer for non-IP packets. Valid values: disable, enable.
    port String
    Ports to sniff (Format examples: 10, 100-200).
    protocol String
    Integer value for the protocol type as defined by IANA (0 - 255).
    systemSnifferId String
    an identifier for the resource with format {{fosid}}.
    vlan String
    List of VLANs to sniff.
    fosid number
    Sniffer ID.
    host string
    Hosts to filter for in sniffer traffic
    interface string
    Interface.
    ipv6 string
    Enable/disable sniffing IPv6 packets. disable - Disable sniffer for IPv6 packets. enable - Enable sniffer for IPv6 packets. Valid values: disable, enable.
    maxPacketCount number
    Maximum packet count (1000000, default = 4000).
    nonIp string
    Enable/disable sniffing non-IP packets. disable - Disable sniffer for non-IP packets. enable - Enable sniffer for non-IP packets. Valid values: disable, enable.
    port string
    Ports to sniff (Format examples: 10, 100-200).
    protocol string
    Integer value for the protocol type as defined by IANA (0 - 255).
    systemSnifferId string
    an identifier for the resource with format {{fosid}}.
    vlan string
    List of VLANs to sniff.
    fosid float
    Sniffer ID.
    host str
    Hosts to filter for in sniffer traffic
    interface str
    Interface.
    ipv6 str
    Enable/disable sniffing IPv6 packets. disable - Disable sniffer for IPv6 packets. enable - Enable sniffer for IPv6 packets. Valid values: disable, enable.
    max_packet_count float
    Maximum packet count (1000000, default = 4000).
    non_ip str
    Enable/disable sniffing non-IP packets. disable - Disable sniffer for non-IP packets. enable - Enable sniffer for non-IP packets. Valid values: disable, enable.
    port str
    Ports to sniff (Format examples: 10, 100-200).
    protocol str
    Integer value for the protocol type as defined by IANA (0 - 255).
    system_sniffer_id str
    an identifier for the resource with format {{fosid}}.
    vlan str
    List of VLANs to sniff.
    fosid Number
    Sniffer ID.
    host String
    Hosts to filter for in sniffer traffic
    interface String
    Interface.
    ipv6 String
    Enable/disable sniffing IPv6 packets. disable - Disable sniffer for IPv6 packets. enable - Enable sniffer for IPv6 packets. Valid values: disable, enable.
    maxPacketCount Number
    Maximum packet count (1000000, default = 4000).
    nonIp String
    Enable/disable sniffing non-IP packets. disable - Disable sniffer for non-IP packets. enable - Enable sniffer for non-IP packets. Valid values: disable, enable.
    port String
    Ports to sniff (Format examples: 10, 100-200).
    protocol String
    Integer value for the protocol type as defined by IANA (0 - 255).
    systemSnifferId String
    an identifier for the resource with format {{fosid}}.
    vlan String
    List of VLANs to sniff.

    Import

    System Sniffer can be imported using any of these accepted formats:

    $ export “FORTIMANAGER_IMPORT_TABLE”=“true”

    $ pulumi import fortimanager:index/systemSniffer:SystemSniffer labelname {{fosid}}

    $ unset “FORTIMANAGER_IMPORT_TABLE”

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

    Package Details

    Repository
    fortimanager fortinetdev/terraform-provider-fortimanager
    License
    Notes
    This Pulumi package is based on the fortimanager Terraform Provider.
    fortimanager logo
    fortimanager 1.13.0 published on Thursday, Mar 13, 2025 by fortinetdev
    fortinetdev/terraform-provider-fortimanager