Docs Packages
  1. Packages
  2. Fortios
  3. API Docs
  4. switchcontroller
  5. Trafficsniffer
Fortios v0.0.5 published on Tuesday, Apr 9, 2024 by pulumiverse
pulumiverse/pulumi-fortios

fortios.switchcontroller.Trafficsniffer

Explore with Pulumi AI

fortios logo
Fortios v0.0.5 published on Tuesday, Apr 9, 2024 by pulumiverse
pulumiverse/pulumi-fortios

    Configure FortiSwitch RSPAN/ERSPAN traffic sniffing parameters. Applies to FortiOS Version >= 6.2.4.

    Create Trafficsniffer Resource

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

    Constructor syntax

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

@overload
def Trafficsniffer(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   dynamic_sort_subtable: Optional[str] = None,
                   erspan_ip: Optional[str] = None,
                   get_all_tables: Optional[str] = None,
                   mode: Optional[str] = None,
                   target_ips: Optional[Sequence[TrafficsnifferTargetIpArgs]] = None,
                   target_macs: Optional[Sequence[TrafficsnifferTargetMacArgs]] = None,
                   target_ports: Optional[Sequence[TrafficsnifferTargetPortArgs]] = None,
                   vdomparam: Optional[str] = None)
    func NewTrafficsniffer(ctx *Context, name string, args *TrafficsnifferArgs, opts ...ResourceOption) (*Trafficsniffer, error)
    public Trafficsniffer(string name, TrafficsnifferArgs? args = null, CustomResourceOptions? opts = null)
    public Trafficsniffer(String name, TrafficsnifferArgs args)
public Trafficsniffer(String name, TrafficsnifferArgs args, CustomResourceOptions options)

    type: fortios:switchcontroller:Trafficsniffer
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 TrafficsnifferArgs
    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 TrafficsnifferArgs
    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 TrafficsnifferArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TrafficsnifferArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TrafficsnifferArgs
    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 trafficsnifferResource = new Fortios.Switchcontroller.Trafficsniffer("trafficsnifferResource", new()
{
    DynamicSortSubtable = "string",
    ErspanIp = "string",
    GetAllTables = "string",
    Mode = "string",
    TargetIps = new[]
    {
        new Fortios.Switchcontroller.Inputs.TrafficsnifferTargetIpArgs
        {
            Description = "string",
            Ip = "string",
        },
    },
    TargetMacs = new[]
    {
        new Fortios.Switchcontroller.Inputs.TrafficsnifferTargetMacArgs
        {
            Description = "string",
            Mac = "string",
        },
    },
    TargetPorts = new[]
    {
        new Fortios.Switchcontroller.Inputs.TrafficsnifferTargetPortArgs
        {
            Description = "string",
            InPorts = new[]
            {
                new Fortios.Switchcontroller.Inputs.TrafficsnifferTargetPortInPortArgs
                {
                    Name = "string",
                },
            },
            OutPorts = new[]
            {
                new Fortios.Switchcontroller.Inputs.TrafficsnifferTargetPortOutPortArgs
                {
                    Name = "string",
                },
            },
            SwitchId = "string",
        },
    },
    Vdomparam = "string",
});

    example, err := switchcontroller.NewTrafficsniffer(ctx, "trafficsnifferResource", &switchcontroller.TrafficsnifferArgs{
	DynamicSortSubtable: pulumi.String("string"),
	ErspanIp:            pulumi.String("string"),
	GetAllTables:        pulumi.String("string"),
	Mode:                pulumi.String("string"),
	TargetIps: switchcontroller.TrafficsnifferTargetIpArray{
		&switchcontroller.TrafficsnifferTargetIpArgs{
			Description: pulumi.String("string"),
			Ip:          pulumi.String("string"),
		},
	},
	TargetMacs: switchcontroller.TrafficsnifferTargetMacArray{
		&switchcontroller.TrafficsnifferTargetMacArgs{
			Description: pulumi.String("string"),
			Mac:         pulumi.String("string"),
		},
	},
	TargetPorts: switchcontroller.TrafficsnifferTargetPortArray{
		&switchcontroller.TrafficsnifferTargetPortArgs{
			Description: pulumi.String("string"),
			InPorts: switchcontroller.TrafficsnifferTargetPortInPortArray{
				&switchcontroller.TrafficsnifferTargetPortInPortArgs{
					Name: pulumi.String("string"),
				},
			},
			OutPorts: switchcontroller.TrafficsnifferTargetPortOutPortArray{
				&switchcontroller.TrafficsnifferTargetPortOutPortArgs{
					Name: pulumi.String("string"),
				},
			},
			SwitchId: pulumi.String("string"),
		},
	},
	Vdomparam: pulumi.String("string"),
})

    var trafficsnifferResource = new Trafficsniffer("trafficsnifferResource", TrafficsnifferArgs.builder()
    .dynamicSortSubtable("string")
    .erspanIp("string")
    .getAllTables("string")
    .mode("string")
    .targetIps(TrafficsnifferTargetIpArgs.builder()
        .description("string")
        .ip("string")
        .build())
    .targetMacs(TrafficsnifferTargetMacArgs.builder()
        .description("string")
        .mac("string")
        .build())
    .targetPorts(TrafficsnifferTargetPortArgs.builder()
        .description("string")
        .inPorts(TrafficsnifferTargetPortInPortArgs.builder()
            .name("string")
            .build())
        .outPorts(TrafficsnifferTargetPortOutPortArgs.builder()
            .name("string")
            .build())
        .switchId("string")
        .build())
    .vdomparam("string")
    .build());

    trafficsniffer_resource = fortios.switchcontroller.Trafficsniffer("trafficsnifferResource",
    dynamic_sort_subtable="string",
    erspan_ip="string",
    get_all_tables="string",
    mode="string",
    target_ips=[fortios.switchcontroller.TrafficsnifferTargetIpArgs(
        description="string",
        ip="string",
    )],
    target_macs=[fortios.switchcontroller.TrafficsnifferTargetMacArgs(
        description="string",
        mac="string",
    )],
    target_ports=[fortios.switchcontroller.TrafficsnifferTargetPortArgs(
        description="string",
        in_ports=[fortios.switchcontroller.TrafficsnifferTargetPortInPortArgs(
            name="string",
        )],
        out_ports=[fortios.switchcontroller.TrafficsnifferTargetPortOutPortArgs(
            name="string",
        )],
        switch_id="string",
    )],
    vdomparam="string")

    const trafficsnifferResource = new fortios.switchcontroller.Trafficsniffer("trafficsnifferResource", {
    dynamicSortSubtable: "string",
    erspanIp: "string",
    getAllTables: "string",
    mode: "string",
    targetIps: [{
        description: "string",
        ip: "string",
    }],
    targetMacs: [{
        description: "string",
        mac: "string",
    }],
    targetPorts: [{
        description: "string",
        inPorts: [{
            name: "string",
        }],
        outPorts: [{
            name: "string",
        }],
        switchId: "string",
    }],
    vdomparam: "string",
});

    type: fortios:switchcontroller:Trafficsniffer
properties:
    dynamicSortSubtable: string
    erspanIp: string
    getAllTables: string
    mode: string
    targetIps:
        - description: string
          ip: string
    targetMacs:
        - description: string
          mac: string
    targetPorts:
        - description: string
          inPorts:
            - name: string
          outPorts:
            - name: string
          switchId: string
    vdomparam: string

    Trafficsniffer Resource Properties

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

    Inputs

    The Trafficsniffer resource accepts the following input properties:

    DynamicSortSubtable string
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    ErspanIp string
    Configure ERSPAN collector IP address.
    GetAllTables string
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    Mode string
    Configure traffic sniffer mode. Valid values: erspan-auto, rspan, none.
    TargetIps List<Pulumiverse.Fortios.Switchcontroller.Inputs.TrafficsnifferTargetIp>
    Sniffer IPs to filter. The structure of target_ip block is documented below.
    TargetMacs List<Pulumiverse.Fortios.Switchcontroller.Inputs.TrafficsnifferTargetMac>
    Sniffer MACs to filter. The structure of target_mac block is documented below.
    TargetPorts List<Pulumiverse.Fortios.Switchcontroller.Inputs.TrafficsnifferTargetPort>
    Sniffer ports to filter. The structure of target_port block is documented below.
    Vdomparam string
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    DynamicSortSubtable string
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    ErspanIp string
    Configure ERSPAN collector IP address.
    GetAllTables string
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    Mode string
    Configure traffic sniffer mode. Valid values: erspan-auto, rspan, none.
    TargetIps []TrafficsnifferTargetIpArgs
    Sniffer IPs to filter. The structure of target_ip block is documented below.
    TargetMacs []TrafficsnifferTargetMacArgs
    Sniffer MACs to filter. The structure of target_mac block is documented below.
    TargetPorts []TrafficsnifferTargetPortArgs
    Sniffer ports to filter. The structure of target_port block is documented below.
    Vdomparam string
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    dynamicSortSubtable String
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    erspanIp String
    Configure ERSPAN collector IP address.
    getAllTables String
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    mode String
    Configure traffic sniffer mode. Valid values: erspan-auto, rspan, none.
    targetIps List<TrafficsnifferTargetIp>
    Sniffer IPs to filter. The structure of target_ip block is documented below.
    targetMacs List<TrafficsnifferTargetMac>
    Sniffer MACs to filter. The structure of target_mac block is documented below.
    targetPorts List<TrafficsnifferTargetPort>
    Sniffer ports to filter. The structure of target_port block is documented below.
    vdomparam String
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    dynamicSortSubtable string
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    erspanIp string
    Configure ERSPAN collector IP address.
    getAllTables string
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    mode string
    Configure traffic sniffer mode. Valid values: erspan-auto, rspan, none.
    targetIps TrafficsnifferTargetIp[]
    Sniffer IPs to filter. The structure of target_ip block is documented below.
    targetMacs TrafficsnifferTargetMac[]
    Sniffer MACs to filter. The structure of target_mac block is documented below.
    targetPorts TrafficsnifferTargetPort[]
    Sniffer ports to filter. The structure of target_port block is documented below.
    vdomparam string
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    dynamic_sort_subtable str
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    erspan_ip str
    Configure ERSPAN collector IP address.
    get_all_tables str
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    mode str
    Configure traffic sniffer mode. Valid values: erspan-auto, rspan, none.
    target_ips Sequence[TrafficsnifferTargetIpArgs]
    Sniffer IPs to filter. The structure of target_ip block is documented below.
    target_macs Sequence[TrafficsnifferTargetMacArgs]
    Sniffer MACs to filter. The structure of target_mac block is documented below.
    target_ports Sequence[TrafficsnifferTargetPortArgs]
    Sniffer ports to filter. The structure of target_port block is documented below.
    vdomparam str
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    dynamicSortSubtable String
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    erspanIp String
    Configure ERSPAN collector IP address.
    getAllTables String
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    mode String
    Configure traffic sniffer mode. Valid values: erspan-auto, rspan, none.
    targetIps List<Property Map>
    Sniffer IPs to filter. The structure of target_ip block is documented below.
    targetMacs List<Property Map>
    Sniffer MACs to filter. The structure of target_mac block is documented below.
    targetPorts List<Property Map>
    Sniffer ports to filter. The structure of target_port block is documented below.
    vdomparam String
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Trafficsniffer 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 Trafficsniffer Resource

    Get an existing Trafficsniffer 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?: TrafficsnifferState, opts?: CustomResourceOptions): Trafficsniffer
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        dynamic_sort_subtable: Optional[str] = None,
        erspan_ip: Optional[str] = None,
        get_all_tables: Optional[str] = None,
        mode: Optional[str] = None,
        target_ips: Optional[Sequence[TrafficsnifferTargetIpArgs]] = None,
        target_macs: Optional[Sequence[TrafficsnifferTargetMacArgs]] = None,
        target_ports: Optional[Sequence[TrafficsnifferTargetPortArgs]] = None,
        vdomparam: Optional[str] = None) -> Trafficsniffer
    func GetTrafficsniffer(ctx *Context, name string, id IDInput, state *TrafficsnifferState, opts ...ResourceOption) (*Trafficsniffer, error)
    public static Trafficsniffer Get(string name, Input<string> id, TrafficsnifferState? state, CustomResourceOptions? opts = null)
    public static Trafficsniffer get(String name, Output<String> id, TrafficsnifferState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    DynamicSortSubtable string
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    ErspanIp string
    Configure ERSPAN collector IP address.
    GetAllTables string
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    Mode string
    Configure traffic sniffer mode. Valid values: erspan-auto, rspan, none.
    TargetIps List<Pulumiverse.Fortios.Switchcontroller.Inputs.TrafficsnifferTargetIp>
    Sniffer IPs to filter. The structure of target_ip block is documented below.
    TargetMacs List<Pulumiverse.Fortios.Switchcontroller.Inputs.TrafficsnifferTargetMac>
    Sniffer MACs to filter. The structure of target_mac block is documented below.
    TargetPorts List<Pulumiverse.Fortios.Switchcontroller.Inputs.TrafficsnifferTargetPort>
    Sniffer ports to filter. The structure of target_port block is documented below.
    Vdomparam string
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    DynamicSortSubtable string
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    ErspanIp string
    Configure ERSPAN collector IP address.
    GetAllTables string
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    Mode string
    Configure traffic sniffer mode. Valid values: erspan-auto, rspan, none.
    TargetIps []TrafficsnifferTargetIpArgs
    Sniffer IPs to filter. The structure of target_ip block is documented below.
    TargetMacs []TrafficsnifferTargetMacArgs
    Sniffer MACs to filter. The structure of target_mac block is documented below.
    TargetPorts []TrafficsnifferTargetPortArgs
    Sniffer ports to filter. The structure of target_port block is documented below.
    Vdomparam string
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    dynamicSortSubtable String
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    erspanIp String
    Configure ERSPAN collector IP address.
    getAllTables String
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    mode String
    Configure traffic sniffer mode. Valid values: erspan-auto, rspan, none.
    targetIps List<TrafficsnifferTargetIp>
    Sniffer IPs to filter. The structure of target_ip block is documented below.
    targetMacs List<TrafficsnifferTargetMac>
    Sniffer MACs to filter. The structure of target_mac block is documented below.
    targetPorts List<TrafficsnifferTargetPort>
    Sniffer ports to filter. The structure of target_port block is documented below.
    vdomparam String
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    dynamicSortSubtable string
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    erspanIp string
    Configure ERSPAN collector IP address.
    getAllTables string
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    mode string
    Configure traffic sniffer mode. Valid values: erspan-auto, rspan, none.
    targetIps TrafficsnifferTargetIp[]
    Sniffer IPs to filter. The structure of target_ip block is documented below.
    targetMacs TrafficsnifferTargetMac[]
    Sniffer MACs to filter. The structure of target_mac block is documented below.
    targetPorts TrafficsnifferTargetPort[]
    Sniffer ports to filter. The structure of target_port block is documented below.
    vdomparam string
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    dynamic_sort_subtable str
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    erspan_ip str
    Configure ERSPAN collector IP address.
    get_all_tables str
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    mode str
    Configure traffic sniffer mode. Valid values: erspan-auto, rspan, none.
    target_ips Sequence[TrafficsnifferTargetIpArgs]
    Sniffer IPs to filter. The structure of target_ip block is documented below.
    target_macs Sequence[TrafficsnifferTargetMacArgs]
    Sniffer MACs to filter. The structure of target_mac block is documented below.
    target_ports Sequence[TrafficsnifferTargetPortArgs]
    Sniffer ports to filter. The structure of target_port block is documented below.
    vdomparam str
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    dynamicSortSubtable String
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    erspanIp String
    Configure ERSPAN collector IP address.
    getAllTables String
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    mode String
    Configure traffic sniffer mode. Valid values: erspan-auto, rspan, none.
    targetIps List<Property Map>
    Sniffer IPs to filter. The structure of target_ip block is documented below.
    targetMacs List<Property Map>
    Sniffer MACs to filter. The structure of target_mac block is documented below.
    targetPorts List<Property Map>
    Sniffer ports to filter. The structure of target_port block is documented below.
    vdomparam String
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.

    Supporting Types

    TrafficsnifferTargetIp, TrafficsnifferTargetIpArgs

    Description string
    Description for the sniffer IP.
    Ip string
    Sniffer IP.
    Description string
    Description for the sniffer IP.
    Ip string
    Sniffer IP.
    description String
    Description for the sniffer IP.
    ip String
    Sniffer IP.
    description string
    Description for the sniffer IP.
    ip string
    Sniffer IP.
    description str
    Description for the sniffer IP.
    ip str
    Sniffer IP.
    description String
    Description for the sniffer IP.
    ip String
    Sniffer IP.

    TrafficsnifferTargetMac, TrafficsnifferTargetMacArgs

    Description string
    Description for the sniffer MAC.
    Mac string
    Sniffer MAC.
    Description string
    Description for the sniffer MAC.
    Mac string
    Sniffer MAC.
    description String
    Description for the sniffer MAC.
    mac String
    Sniffer MAC.
    description string
    Description for the sniffer MAC.
    mac string
    Sniffer MAC.
    description str
    Description for the sniffer MAC.
    mac str
    Sniffer MAC.
    description String
    Description for the sniffer MAC.
    mac String
    Sniffer MAC.

    TrafficsnifferTargetPort, TrafficsnifferTargetPortArgs

    Description string
    Description for the sniffer port entry.
    InPorts List<Pulumiverse.Fortios.Switchcontroller.Inputs.TrafficsnifferTargetPortInPort>
    Configure source ingress port interfaces. The structure of in_ports block is documented below.
    OutPorts List<Pulumiverse.Fortios.Switchcontroller.Inputs.TrafficsnifferTargetPortOutPort>
    Configure source egress port interfaces. The structure of out_ports block is documented below.
    SwitchId string
    Managed-switch ID.
    Description string
    Description for the sniffer port entry.
    InPorts []TrafficsnifferTargetPortInPort
    Configure source ingress port interfaces. The structure of in_ports block is documented below.
    OutPorts []TrafficsnifferTargetPortOutPort
    Configure source egress port interfaces. The structure of out_ports block is documented below.
    SwitchId string
    Managed-switch ID.
    description String
    Description for the sniffer port entry.
    inPorts List<TrafficsnifferTargetPortInPort>
    Configure source ingress port interfaces. The structure of in_ports block is documented below.
    outPorts List<TrafficsnifferTargetPortOutPort>
    Configure source egress port interfaces. The structure of out_ports block is documented below.
    switchId String
    Managed-switch ID.
    description string
    Description for the sniffer port entry.
    inPorts TrafficsnifferTargetPortInPort[]
    Configure source ingress port interfaces. The structure of in_ports block is documented below.
    outPorts TrafficsnifferTargetPortOutPort[]
    Configure source egress port interfaces. The structure of out_ports block is documented below.
    switchId string
    Managed-switch ID.
    description str
    Description for the sniffer port entry.
    in_ports Sequence[TrafficsnifferTargetPortInPort]
    Configure source ingress port interfaces. The structure of in_ports block is documented below.
    out_ports Sequence[TrafficsnifferTargetPortOutPort]
    Configure source egress port interfaces. The structure of out_ports block is documented below.
    switch_id str
    Managed-switch ID.
    description String
    Description for the sniffer port entry.
    inPorts List<Property Map>
    Configure source ingress port interfaces. The structure of in_ports block is documented below.
    outPorts List<Property Map>
    Configure source egress port interfaces. The structure of out_ports block is documented below.
    switchId String
    Managed-switch ID.

    TrafficsnifferTargetPortInPort, TrafficsnifferTargetPortInPortArgs

    Name string
    Interface name.
    Name string
    Interface name.
    name String
    Interface name.
    name string
    Interface name.
    name str
    Interface name.
    name String
    Interface name.

    TrafficsnifferTargetPortOutPort, TrafficsnifferTargetPortOutPortArgs

    Name string
    Interface name.
    Name string
    Interface name.
    name String
    Interface name.
    name string
    Interface name.
    name str
    Interface name.
    name String
    Interface name.

    Import

    SwitchController TrafficSniffer can be imported using any of these accepted formats:

    $ pulumi import fortios:switchcontroller/trafficsniffer:Trafficsniffer labelname SwitchControllerTrafficSniffer

    If you do not want to import arguments of block:

    $ export “FORTIOS_IMPORT_TABLE”=“false”

    $ pulumi import fortios:switchcontroller/trafficsniffer:Trafficsniffer labelname SwitchControllerTrafficSniffer

    $ unset “FORTIOS_IMPORT_TABLE”

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

    Package Details

    Repository
    fortios pulumiverse/pulumi-fortios
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the fortios Terraform Provider.
    fortios logo
    Fortios v0.0.5 published on Tuesday, Apr 9, 2024 by pulumiverse
    pulumiverse/pulumi-fortios